IBM API Hub
Maximo Application Suite Admin APIs 9.0.x

By IBM Maximo

Provides REST APIs for performing Suite administration operations.


API reference

Get details about SCIM Sync configuration

GET

/config/scim/{scimId}

Requires System administration permissions .

Request URL
https://api.{mas-instance-id}.{mas-domain}/config/scim/{scimId}
Security
apiKey
x-access-token
required in header
Parameters
Name
Description
  • scimId
    REQUIRED
    string
    (path)

    SCIM Id

    Minimum length: 3
    Maximum length: 24
  • Accept
    string
    (header)
    application/json
  • Responses
    • 200

      SCIM Sync configuration

    • 401

      Authentication token is empty or invalid

    • 403

      Authenticated user is not permitted to make the request

    • 404

      The requested resource could not be found

    • 500

      An internal server error occured

    Code snippet
      1curl --request GET \
      2  --url https://api.replace_mas-instance-id_variable.replace_mas-domain_variable/config/scim/REPLACE_SCIMID \
      3  --header 'accept: application/json' \
      4  --header 'x-access-token: REPLACE_THIS_VALUE'

        Example response

          1{
          2  "metadata": {
          3    "creationTimestamp": "2020-02-20T13:54:00",
          4    "deletionTimestamp": "2020-02-20T13:58:00"
          5  },
          6  "spec": {
          7    "displayName": "Olivia Stokes",
          8    "type": "neobu",
          9    "config": {
          10      "syncFrequency": "0 7 * * 1",
          11      "issuer": "_local",
          12      "entitlement": {
          13        "application": "BASE"
          14      },
          15      "workspaces": [
          16        {
          17          "id": "Id",
          18          "applications": [
          19            "iot"
          20          ]
          21        }
          22      ],
          23      "ldapAuth": {
          24        "url": "ldaps://ldap.forumsys.com:636",
          25        "baseDN": "dc=example,dc=com",
          26        "certificates": [
          27          {
          28            "alias": "alias",
          29            "crt": "-----BEGIN CERTIFICATE----- \\n-----END CERTIFICATE-----\\n"
          30          }
          31        ],
          32        "credentials": {
          33          "secretName": "objectstorage-ibmcloud-admin"
          34        }
          35      },
          36      "userSync": {
          37        "userBaseDN": "ou=users,dc=example,dc=com",
          38        "userIdMap": "*:cn",
          39        "userFilter": "(&(cn=%v)(objectClass=inetOrgPerson))",
          40        "mappings": {}
          41      },
          42      "groupSync": {
          43        "syncGroups": true,
          44        "groupFilter": "(&(cn=%v)(objectClass=groupOfNames))",
          45        "groupIdMap": "*:cn",
          46        "groupMemberIdMap": "groupOfNames:member",
          47        "groupBaseDN": "dc=example,dc=com",
          48        "mappings": {}
          49      },
          50      "customMaxSearchResults": 4500,
          51      "ldapType": "Microsoft Active Directory"
          52    }
          53  },
          54  "status": {
          55    "conditions": [
          56      {
          57        "lastTransitionTime": "2020-08-10T16:45:47Z",
          58        "reason": "Ready",
          59        "message": "Configuration was updated successfully",
          60        "status": "True",
          61        "type": "Ready"
          62      }
          63    ],
          64    "config": {
          65      "syncFrequency": "0 7 * * 1",
          66      "issuer": "_local",
          67      "entitlement": {
          68        "application": "BASE"
          69      },
          70      "workspaces": [
          71        {
          72          "id": "Id",
          73          "applications": [
          74            "iot"
          75          ]
          76        }
          77      ],
          78      "ldapAuth": {
          79        "url": "ldaps://ldap.forumsys.com:636",
          80        "baseDN": "dc=example,dc=com",
          81        "certificates": [
          82          {
          83            "alias": "alias",
          84            "crt": "-----BEGIN CERTIFICATE----- \\n-----END CERTIFICATE-----\\n"
          85          }
          86        ],
          87        "credentials": {
          88          "secretName": "objectstorage-ibmcloud-admin"
          89        }
          90      },
          91      "userSync": {
          92        "userBaseDN": "ou=users,dc=example,dc=com",
          93        "userIdMap": "*:cn",
          94        "userFilter": "(&(cn=%v)(objectClass=inetOrgPerson))",
          95        "mappings": {}
          96      },
          97      "groupSync": {
          98        "syncGroups": true,
          99        "groupFilter": "(&(cn=%v)(objectClass=groupOfNames))",
          100        "groupIdMap": "*:cn",
          101        "groupMemberIdMap": "groupOfNames:member",
          102        "groupBaseDN": "dc=example,dc=com",
          103        "mappings": {}
          104      },
          105      "customMaxSearchResults": 4500,
          106      "ldapType": "Microsoft Active Directory"
          107    },
          108    "report": {
          109      "scimsync-server": {
          110        "ready": true,
          111        "users": 500,
          112        "groups": 10,
          113        "error": null
          114      },
          115      "...
          
          Example is truncated for better usability.
          To see the full example, use the Copy button to copy it to the clipboard.