The Read SCIM operation is used to get users from Condeco based on userid/filter value.

Examples:

  1. Request to read a user by Condeco ID
  2. Request to read user by filter

Read example 1

Request to read a user by Condeco ID

Request

GET "https://<CONDECO-SCIM-Domain>/scim/api/V1/users/162"

Response

HTTP/1.1 200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "162",
  "externalId": "JohnSmith123",
  "meta": {
        "resourceType": "User",
        "created": "2020-11-02T14:12:04.827",
        "location": "https://<CONDECO-SCIM-Domain>/scim/api/V1/users/162"
  },
  "userName": "John.Smith",
  "active": true,
  "name": {
    "familyName": "Smith",
    "givenName": "John"
  },
  "emails": [
    {
      "primary": true,
      "value": "John.Smith@sampledomain.com"
    }
  ],
  "phoneNumbers": [
    {
      "primary": true,
      "value": "9000000000"
    },
    {
      "primary": false,
      "type": "mobile",
      "value": "9999999999"
    }
  ]
}

Read example 2:

Request to read user by filter

Request

GET "https://<CONDECO-SCIM-Domain>/scim/api/V1/users?filter=userName eq "John.Smith""

Response

HTTP/1.1 200 OK

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "162",
      "externalId": "JohnSmith123",
      "meta": {
        "resourceType": "User",
        "created": "2020-11-02T14:12:04.827",
        "location": "https://<CONDECO-SCIM-Domain>/scim/api/V1/users/162"
      },
      "userName": "John.Smith",
      "active": true,
      "name": {
        "familyName": "Smith",
        "givenName": "John"
      },
      "emails": [
        {
          "primary": true,
          "value": "John.Smith@sampledomain.com"
        }
      ],
      "phoneNumbers": [
        {
          "primary": true,
          "value": "9000000000"
        },
        {
          "primary": false,
          "type": "mobile",
          "value": "9999999999"
        }
      ]
    }
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 200
}

Feedback

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Post your comment on this topic.

Please do not use this for support questions.
Condeco Support

Post Comment