DQM-identity

[RandySoulis]

The DQM Website API calls provide information relating to users setup within your DQM instance.

GET users clients

https://api.crownpeak.net/dqm-identity/v1/users/:userId/clients

Returns a list of Clients the specified User has access to.

Note: The term client can be used as a synonym for a single DQM instance. Although its not common it is possible to have access to multiple clients. For this reason clientId is included in many calls as a required query parameter.

AUTHORIZATION

Bearer Token

HEADERS

---

Authorization

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c Bearer token from DQM-security

PATH VARIABLES

---

userId

1234 The userId for a list of potential clients

Example Request

curl --location --request GET 'https://api.crownpeak.net/dqm-identity/v1/v1/users/1234/clients' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'

Example Response (body)

{
  "clients": [
    {
      "id": "abc123",
      "name": "Acme Corp",
      "status": "PROD"
    },
    {
      "id": "def456",
      "name": "Acme Shipping",
      "status": "PROD"
    },
    {
      "id": "ghi789",
      "name": "Acme Industries",
      "status": "PROD"
    }
  ]
}

 Example Response (Headers)

Connection: keep-alive
Content-Length: 21884
Content-Type: application/json
Date: Fri, 13 Jul 2018 15:44:27 GMT
Via: 1.1 9132f1c6fe5ab3ea458d3abc7e3bc5d4.cloudfront.net (CloudFront)
X-Amz-Cf-Id: qr99gXlE0oUBdDxb0GRVWEczcLsnBNcs3BwdP-Y_NPn4b6IdlH2HWA==
X-Amzn-Trace-Id: Root=1-5b48c8db-bc908eb265cb42e0ece4afc6
X-Cache: Miss from cloudfront
x-amz-apigw-id: J-RSSG7ljoEFcRQ=
x-amzn-RequestId: 9fdf27fb-86b3-11e8-b353-03144533ee8a

[josep]

Where does the "userId" come from?

Thanks.

[RandySoulis]

Hello,

The UserId will be returned in the token when you authenticate (i.e. https://api.crownpeak.net/dqm-security/v1/authenticate). Take the token and paste it in the debugger on this page and you will see the uid field.

Let me know if you have any additional questions.