Get Get User

Get Get User

The user id is a unique internal identifier and can be retrieved using the search API /scim/Users?filter=...

Request
URI
GET
https://{api_host}//SAAS/jersey/manager/api/scim/Users/{id}
COPY
Path Parameters
string
id
Required

the id of the user to retrieve

id example
d24afa39-05a1-433f-8aa9-ad41c9a3d394
Query Parameters
string
attributes
Optional

when specified, the returned user will contain the minimal set of user attributes plus the attributes or sub-attributes explicitly requested

string
directoryUuid
Optional

the directory identifier. This identifier will be used to retrieve local directory's user attribute definitions (if any). If not specified, the user attribute definitions defined for the tenant will be used.

directoryUuid example
ca6c160e-5bb9-422c-8d71-777a90241dea
string
customSchemaExtensionTypes
Optional

custom schema extension types for which user schema attributes needs to be included

customSchemaExtensionTypes example
my-custom-schema

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns SdkUserResource of type(s) application/json
{
    "phoneNumbers": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "addresses": [
        {
            "locality": "string",
            "country": "string",
            "region": "string",
            "primary": false,
            "formatted": "string",
            "streetAddress": "string",
            "postalCode": "string",
            "type": "string"
        }
    ],
    "locale": "string",
    "userType": "string",
    "meta": {
        "lastModified": "string",
        "version": "string",
        "location": "string",
        "created": "string"
    },
    "id": "string",
    "resourceDescriptor": {
        "endpoint": "string",
        "description": "string",
        "name": "string",
        "attributeSchemas": [
            "string"
        ],
        "strictMode": false,
        "scimObject": {
            "schemas": [
                "string"
            ]
        },
        "meta": {
            "lastModified": "string",
            "version": "string",
            "location": "string",
            "created": "string"
        },
        "externalId": "string",
        "attributes": [
            {
                "subAttributes": [
                    "AttributeDescriptor Object"
                ],
                "description": "string",
                "canonicalValues": [
                    {
                        "operation": "string",
                        "type": "string",
                        "primary": false,
                        "value": "string",
                        "display": "string"
                    }
                ],
                "dataType": "string",
                "required": false,
                "caseExact": false,
                "name": "string",
                "readOnly": false,
                "multiValuedChildName": "string",
                "multiValued": false,
                "schema": "string"
            }
        ],
        "schema": "string",
        "id": "string",
        "resourceDescriptor": "ResourceDescriptor Object"
    },
    "title": "string",
    "preferredLanguage": "string",
    "scimObject": {
        "schemas": [
            "string"
        ]
    },
    "ims": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "externalId": "string",
    "entitlements": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "nickName": "string",
    "urn:scim:schemas:extension:workspace:1.0": {
        "distinguishedName": "CN=user1,CN=Users,DC=acme,DC=com",
        "domain": "acme.com",
        "internalUserType": "PROVISIONED",
        "softDeleted": false,
        "userPrincipalName": "[email protected]",
        "userStatus": "1",
        "userStoreUuid": "19175b6d-a656-451a-9d25-b62e12d90a24",
        "firstLoginUrl": "string"
    },
    "photos": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "groups": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "active": false,
    "password": "string",
    "emails": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "userName": "string",
    "displayName": "string",
    "name": {
        "honorificPrefix": "string",
        "middleName": "string",
        "familyName": "string",
        "formatted": "string",
        "givenName": "string",
        "honorificSuffix": "string"
    },
    "roles": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "urn:scim:schemas:extension:enterprise:1.0": {
        "manager": {
            "displayName": "string",
            "managerId": "string"
        },
        "employeeNumber": "100007"
    },
    "profileUrl": "string",
    "timeZone": "string"
}
phoneNumbers
Optional

phoneNumbers

array of Address
addresses
Optional

addresses

string
locale
Optional

locale

string
userType
Optional

userType

meta
Optional

meta

string
id
Optional

id

resourceDescriptor
Optional

resourceDescriptor

string
title
Optional

title

string
preferredLanguage
Optional

preferredLanguage

scimObject
Optional

scimObject

ims
Optional

ims

string
externalId
Optional

externalId

entitlements
Optional

entitlements

string
nickName
Optional

nickName

urn:scim:schemas:extension:workspace:1.0
Optional

urn:scim:schemas:extension:workspace:1.0

photos
Optional

photos

groups
Optional

groups

boolean
active
Optional

active

string
password
Optional

password

emails
Optional

emails

string
userName
Optional

userName

string
displayName
Optional

displayName

name
Optional

name

roles
Optional

roles

urn:scim:schemas:extension:enterprise:1.0
Optional

urn:scim:schemas:extension:enterprise:1.0

string
profileUrl
Optional

profileUrl

string
timeZone
Optional

timeZone