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 LDAP configuration

GET

/config/ldap/{idpId}

Available to all authenticated users as long as userDataPrivacyAccess is set to ALL. Non user admins will only receive non sensitive user data (id and username) when userDataPrivacyAccess is set to NON_SENSITIVE_DATA. Non user admins will not have access to this api when userDataPrivacyAccess is set to NO_ACCESS.

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

    IDP Id

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

      External LDAP IDP 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/ldap/REPLACE_IDPID \
      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": "ldap",
          8    "ldap": {
          9      "url": "ldaps://ldap.ibm.com:636",
          10      "baseDN": "dc=example,dc=org",
          11      "userIdMap": "cn",
          12      "credentials": {
          13        "secretName": "ldap-credentials"
          14      }
          15    },
          16    "certificates": [
          17      {
          18        "alias": "intermediate",
          19        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
          20      }
          21    ]
          22  },
          23  "status": {
          24    "conditions": [
          25      {
          26        "lastTransitionTime": "2020-08-10T16:45:47Z",
          27        "reason": "Ready",
          28        "message": "Configuration was updated successfully",
          29        "status": "True",
          30        "type": "Ready"
          31      }
          32    ],
          33    "certificates": [
          34      {
          35        "alias": "intermediate",
          36        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
          37      }
          38    ],
          39    "version": {
          40      "reconciled": "8.4.0"
          41    }
          42  }
          43}