Get User by SCIM Id

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Allows you to retrieve the details of a specific user in your organisation by their ID. You can use either the numeric ID or the SCIM ID to fetch the user. The API returns the user's name, email address, active status, and assigned role.

Example request

curl --location 'https://eu.api.capillarytech.com/launchpad/api/v2/Users/50795539' \
--header 'Authorization: Bearer 7351f986b6c1ce4856883b5b1ca12b277eb3c483b5168613664505170eabac1d' \
--header 'Cookie: CS=e3f2bfa2cd6323fbddfa034e226084b8'

Prerequisites

  • A valid SCIM bearer token for your organization, generated using the Create SCIM Token API. Pass it in the request header as Authorization: Bearer {token}.

Path parameters

FieldTypeRequiredDescription
idstringYesThe ID of the user you want to retrieve. Accepts either a numeric ID (e.g. 50795539) for users created directly in the system, or a SCIM ID (e.g. scim-1777291410320) for users onboarded through the SCIM flow.

Example response

{
    "id": "scim-1780291539381",
    "userName": "[email protected]",
    "name": {
        "givenName": "Cap",
        "familyName": "demo"
    },
    "displayName": "Cap demo",
    "emails": [
        {
            "value": "[email protected]",
            "type": "work",
            "primary": true
        }
    ],
    "active": true,
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ]
}

Response parameters

FieldTypeDescription
schemasarrayIndicates the type of resource being returned. Always returns "urn:ietf:params:scim:schemas:core:2.0:User" for a single user response.
idstringThe unique ID of the retrieved user in the Capillary system. This is the same ID you passed in the request.
userNamestringThe unique identifier of the retrieved user, typically their email address.
displayNamestringThe name displayed for the retrieved user on the platform.
activebooleanIndicates whether the retrieved user's account is currently active.
name.givenNamestringThe first name of the retrieved user.
name.familyNamestringThe last name of the retrieved user.
emailsarrayThe email addresses associated with the retrieved user.
emails.valuestringThe email address of the retrieved user.
emails.typestringThe type of email address of the retrieved user. Always returns work.
emails.primarybooleanIndicates whether this is the retrieved user's primary email address. Always returns true.

Error codes

CodeTypeDescription
401ErrorAuthorization header is missing or is not a valid Bearer token.
403ErrorToken is invalid or not associated with any org.
404ErrorNo user was found for the given ID in the org.

Path Params
string
required
Headers
string
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json