Get Credentials

To get a credential, the client must send a GET request to: /aims/rs/scim/v2/Credential/<id>.

The server returns the specified credential representation from its id. The credential ids are returned as part of a Device – see the Device API.

The possible HTTP status codes returned are:

  • 200: OK

  • 400: Bad Request

  • 401: Unauthorized

  • 403: Forbidden

  • 404: Not Found

Example request:

Copy 
GET /aims/rs/scim/v2/Credential/OP_2.047900503004400045678-PIV_AUTHENTICATION-186C179FBE9
Host: cms.mycompany.com
Authorization: Bearer h480djs93hd8

Example response:

Copy 
HTTP/1.1 200
Content-Type: application/scim+json

{
  "schemas": ["urn:hid:scim:api:cms:1.0:Credential"],
  "id": "OP_2.047900503004400045678-PIV_AUTHENTICATION-186C179FBE9",
  "name": "PIV_AUTHENTICATION",
  "status": {
    "status": "ACTIVE"
  },
  "expirationDate": "2023-06-21T07:08:44.671Z",
  "externalIds": [
    {
      "SN": "OP_2.047900503004400045678"
    }
  ],
  "urn:hid:scim:api:cms:1.0:CredentialX509": {
    "authority": "CN=ROOTCA,DC=cms,DC=mycompany,DC=com",
    "subject": "CN=jdoe,CN=Users, DC=cms,DC=mycompany,DC=com"
  },
  "meta": {
    "created": "2023-06-21T07:08:44.670Z",
    "lastModified": "2023-06-21T07:08:44.670Z",
    "location": "https://cms.mycompany.com/aims/rs/scim/v2/Credential/OP_2.047900503004400045678-PIV_AUTHENTICATION-186C179FBE9",
    "resourceType": "Credential"
 }
}