Create User | VMware Identity Broker

Create User

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

Request

URI

POST

https://{api_host}//usergroup/t/{tenant}/scim/v2/Users

COPY

Path Parameters

string

tenant

Required

The VMware Identity Services tenant ID

tenant example

my-tenant

Request Body

UserMedia of type(s) application/scim+json

Required

{
    "name": {
        "familyName": "MyFamilyName",
        "middleName": "MyMiddleName",
        "givenName": "MyGivenName"
    },
    "displayName": "My Display Name",
    "addresses": [
        {
            "type": "home",
            "region": "CA",
            "country": "USA",
            "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
            "streetAddress": "456 Hollywood Blvd",
            "postalCode": "91608",
            "primary": true,
            "locality": "Hollywood"
        }
    ],
    "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"
        }
    ],
    "photos": [
        {
            "value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
            "type": "photo",
            "primary": true,
            "display": "Example photo"
        }
    ],
    "phoneNumbers": [
        {
            "value": "555-555-5555",
            "type": "work",
            "primary": true
        }
    ],
    "ims": [
        {
            "value": "[email protected]",
            "type": "skype",
            "primary": true,
            "display": "ims_example"
        }
    ],
    "userName": "my_user_name",
    "title": "Example title",
    "groups": [
        {
            "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
            "$ref": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
            "display": "Example Group"
        }
    ],
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}

UserNameMedia

name

Optional

name

string

displayName

Optional

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

array of UserAddressMedia

addresses

Optional

The physical mailing addresses for this user

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 UserEmailMedia

emails

Optional

The list of emails associated with the user

array of UserPhoto

photos

Optional

The URIs of photos of the user

array of UserPhoneNumberMedia

phoneNumbers

Optional

The phone numbers for the user

array of UserInstantMessagingAddressMedia

ims

Optional

The instant messaging addresses for the user

string

userName

Required

The unique identifier of the user

string

title

Optional

The title of the user

array of UserGroupMedia

groups

Optional

The list of groups that the user belongs to

string

Optional

The unique identifier of the SCIM resource

string

externalId

Optional

The SCIM resource external identifier

MetaMedia

meta

Optional

meta

array of string

schemas

Optional

The SCIM resource schema URIs

Authentication

This operation uses the following authentication methods.

basic_auth

admin

Responses

200

The user was successfully created.

Returns UserMedia of type(s) application/scim+json

{
    "name": {
        "familyName": "MyFamilyName",
        "middleName": "MyMiddleName",
        "givenName": "MyGivenName"
    },
    "displayName": "My Display Name",
    "addresses": [
        {
            "type": "home",
            "region": "CA",
            "country": "USA",
            "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
            "streetAddress": "456 Hollywood Blvd",
            "postalCode": "91608",
            "primary": true,
            "locality": "Hollywood"
        }
    ],
    "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"
        }
    ],
    "photos": [
        {
            "value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
            "type": "photo",
            "primary": true,
            "display": "Example photo"
        }
    ],
    "phoneNumbers": [
        {
            "value": "555-555-5555",
            "type": "work",
            "primary": true
        }
    ],
    "ims": [
        {
            "value": "[email protected]",
            "type": "skype",
            "primary": true,
            "display": "ims_example"
        }
    ],
    "userName": "my_user_name",
    "title": "Example title",
    "groups": [
        {
            "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
            "$ref": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
            "display": "Example Group"
        }
    ],
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}

UserNameMedia

name

Optional

name

string

displayName

Optional

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

array of UserAddressMedia

addresses

Optional

The physical mailing addresses for this user