Get Get User For Authenticated User

Get Get User For Authenticated User

Display the information for the user associated with the provided access token. The user's attributes can be filtered using the 'attributes' parameter.

Request
URI
GET
https://{api_host}/SAAS/jersey/manager/api/scim/Me
COPY
Query Parameters
string
attributes
Optional

list of attributes to return, separated by comma. When specified, the retrieved user will only contain the minimal set of user attributes plus the attributes or sub-attributes explicitly requested

attributes example
userName,groups
string
customSchemaExtensionTypes
Optional

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

customSchemaExtensionTypes example
myCustomSchema
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"
}
array of object
phoneNumbers
Optional

phoneNumbers

array of object
addresses
Optional

addresses

string
locale
Optional

locale

string
userType
Optional

userType

object
meta
Optional

meta

string
id
Optional

id

object
resourceDescriptor
Optional

resourceDescriptor

string
title
Optional

title

string
preferredLanguage
Optional

preferredLanguage

object
scimObject
Optional

scimObject

array of object
ims
Optional

ims

string
externalId
Optional

externalId

array of object
entitlements
Optional

entitlements

string
nickName
Optional

nickName

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

urn:scim:schemas:extension:workspace:1.0

array of object
photos
Optional

photos

array of object
groups
Optional

groups

boolean
active
Optional

active

string
password
Optional

password

array of object
emails
Optional

emails

string
userName
Optional

userName

string
displayName
Optional

displayName

object
name
Optional

name

array of object
roles
Optional

roles

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

urn:scim:schemas:extension:enterprise:1.0

string
profileUrl
Optional

profileUrl

string
timeZone
Optional

timeZone


400

The specified "attributes" parameter is invalid

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/SAAS/jersey/manager/api/scim/Me
On This Page
Scim Operations
GET
Get Get User For Authenticated User