Get User

Get User

This endpoint is responsible for fetching a user. For more information, check the specification: https://tools.ietf.org/html/rfc7644#section-3.4.1.

Request
URI
GET
https://{api_host}/usergroup/t/{tenant}/scim/v2/Users/{id}
COPY
Path Parameters
string
id
Required

The ID of the user

string
tenant
Required

The VMware Identity Services tenant ID

tenant example
my-tenant
Query Parameters
string
attributes
Optional

Returns resource with only requested attributes. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.5).

attributes example
name,meta
string
excludedAttributes
Optional

Returns resource with all default and always returned attributes without excluded attributes. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.5).

excludedAttributes example
name,meta
Authentication
This operation uses the following authentication methods.
Responses
200

The user was successfully fetched.

Returns UserMedia of type(s) application/scim+json 
{
    "name": {
        "familyName": "MyFamilyName",
        "middleName": "MyMiddleName",
        "givenName": "MyGivenName"
    },
    "displayName": "My Display Name",
    "nickName": "My Casual Name",
    "profileUrl": "https://example.com/usergroup/scim/v2/Users/da916af2-4c19-4ddb-89bd-363dbb79da29",
    "active": true,
    "emails": [
        {
            "value": "[email protected]",
            "primary": "true",
            "display": "my work email"
        }
    ],
    "phoneNumbers": [
        {
            "value": "555-555-5555",
            "type": "work",
            "primary": true
        }
    ],
    "ims": [
        {
            "value": "[email protected]",
            "type": "skype",
            "primary": true,
            "display": "ims_example"
        }
    ],
    "photos": [
        {
            "value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
            "type": "photo",
            "primary": true,
            "display": "Example photo"
        }
    ],
    "addresses": [
        {
            "type": "home",
            "region": "CA",
            "country": "USA",
            "primary": true,
            "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
            "streetAddress": "456 Hollywood Blvd",
            "postalCode": "91608",
            "locality": "Hollywood"
        }
    ],
    "userName": "my_user_name",
    "groups": [
        {
            "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
            "$ref": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
            "display": "Example Group"
        }
    ],
    "title": "Example title",
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}
object
name
Optional

The name of the user

string
displayName
Optional

The name of the user, suitable for display to end-users

string
nickName
Optional

The casual way to address the user

string As uri As uri
profileUrl
Optional

A fully qualified URL to a page representing the user's online profile

boolean
active
Optional

A Boolean value indicating the user's administrative status

array of object
emails
Optional

The list of emails associated with the user

array of object
phoneNumbers
Optional

The phone numbers for the user

array of object
ims
Optional

The instant messaging addresses for the user

array of object
photos
Optional

The URIs of photos of the user

array of object
addresses
Optional

The physical mailing addresses for this user

string
userName
Required

The unique identifier of the user

array of object
groups
Optional

The list of groups that the user belongs to

string
title
Optional

The title of the user

string
id
Optional

The unique identifier of the SCIM resource

string
externalId
Optional

The SCIM resource external identifier

object
meta
Optional

The meta information of the resource

array of string
schemas
Optional

The SCIM resource schema URIs


400

Invalid filter input.

Operation doesn't return any data structure

404

The user was not found.

Operation doesn't return any data structure

500

Unexpected error.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/usergroup/t/{tenant}/scim/v2/Users/{id}
On This Page
Scim2 Operations
GET
Get User Search
POST
Create User
DELETE
Delete User
GET
Get User
PATCH
Patch User
PUT
Put User
POST
Post User Search