BAballerina-platform
Users Endpoint

Get User by ID

Changed on

Return user details if a user found.

  • <b>Scope(Permission) required:</b> internal_user_mgt_view

  • <b>Flow type:</b> Client Credentials OAuth Flow

get/Users/{id}

Request

Path parameters

idstring required

Unique ID of the resource type.

Query parameters

attributesstring

SCIM defined attributes parameter.

excludedAttributesstring

SCIM defined excludedAttribute parameter.

Response

Valid user is found

schemasstring[]
usernamestring
idstring

Example response

{
  "meta": {
    "created": "2018-08-17T10:34:29.000Z",
    "location": "https://api.asgardeo.io/t/{org-name}/scim2/Users/008bba85-451d-414b-87de-c03b5a1f4217",
    "lastModified": "2018-08-17T10:34:29.000Z",
    "resourceType": "User"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "username": "DEFAULT/kim@gmail.com",
  "id": "008bba85-451d-414b-87de-c03b5a1f4217",
  "name": {
    "givenName": "Kim",
    "familyName": "Berry"
  },
  "emails": [
    "kim@gmail.com"
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "manager": {
      "value": "Taylor"
    }
  },
  "roles": [
    {
      "type": "default",
      "value": "Internal/everyone"
    }
  ]
}

Changes

  • 7978594f207eRevision changes
    • breaking

      response property emails/items/ list-of-types was widened by adding types string to media type application/scim+json of response 200

    • breaking

      the response's property type changed from object to array for status

    • breaking

      the response's property type changed from object to array for status

  • d290ee2c70fcRevision changes
    • breaking

      the response's property type changed from array to object for status

    • breaking

      the response's property type changed from array to object for status

    • info

      response property emails/items/ list-of-types was narrowed by removing types string from media type application/scim+json of response 200