Creating a User_SCIM User Management_API_API Reference

Function

This API is used to synchronize a user to IAM Identity Center using the System for Cross-domain Identity Management (SCIM) protocol.

URI

POST /{tenant_id}/scim/v2/Users

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Globally unique ID of a tenant.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Bearer token.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
externalId	No	String	External ID.
userName	Yes	String	Username, which uniquely identifies a user.
name	Yes	Object	User's name.
displayName	Yes	String	Display name of a user.
nickName	No	String	Nickname of a user.
profileUrl	No	String	URL associated with a user.
emails	Yes	Array of objects	Email addresses of a user.
addresses	No	Array of objects	Addresses of a user.
phoneNumbers	No	Array of objects	Phone numbers of a user.
userType	No	String	User type.
title	No	String	User title.
preferredLanguage	No	String	User's preferred language.
locale	No	String	Geographical area or location of a user.
timezone	No	String	Time zone of a user.
active	No	Boolean	Whether a user is enabled.
schemas	Yes	Array of strings	Summary.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	No	Object	User work information.

**Table 4** name
Parameter	Mandatory	Type	Description
formatted	No	String	Formatted name to be displayed.
familyName	Yes	String	Family name of a user.
givenName	Yes	String	Given name of a user.
middleName	No	String	Middle name of a user.
honorificPrefix	No	String	Prefix of a user's name.
honorificSuffix	No	String	Suffix of a user's name.

**Table 5** emails
Parameter	Mandatory	Type	Description
value	Yes	String	Email address.
type	Yes	String	Email address type.
primary	Yes	Boolean	Whether the value is the user's primary email address.

**Table 6** addresses
Parameter	Mandatory	Type	Description
formatted	No	String	Formatted address to be displayed.
streetAddress	No	String	Street.
locality	No	String	Location.
region	No	String	Region.
postalCode	No	String	Postal code.
country	No	String	Country or region.
type	No	String	Address type.
primary	No	Boolean	Whether the address is the user's primary address.

**Table 7** phoneNumbers
Parameter	Mandatory	Type	Description
value	No	String	Phone number.
type	No	String	Phone number type.
primary	No	Boolean	Whether the value is the user's primary phone number.

**Table 8** urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
Parameter	Mandatory	Type	Description
costCenter	No	String	Cost Center. Minimum length: 1 Maximum length: 1024
department	No	String	Department. Minimum length: 1 Maximum length: 1024
division	No	String	Division. Minimum length: 1 Maximum length: 1024
employeeNumber	No	String	Employee ID. Minimum length: 1 Maximum length: 1024
manager	No	Object	Manager.
organization	No	String	Organization. Minimum length: 1 Maximum length: 1024

**Table 9** manager
Parameter	Mandatory	Type	Description
value	No	String	Manager. Minimum length: 1 Maximum length: 1024

Response Parameters

Status code: 201

**Table 10** Parameters in the response body
Parameter	Type	Description
id	String	Globally unique ID of a user.
externalId	String	External ID.
meta	Object	Metadata.
schemas	Array of strings	Summary.
userName	String	Username, which uniquely identifies a user.
name	Object	User's name.
displayName	String	Display name of a user.
nickName	String	Nickname of a user.
title	String	User title.
userType	String	User type.
preferredLanguage	String	User's preferred language.
locale	String	Geographical area or location of a user.
timezone	String	Time zone of a user.
active	Boolean	Whether a user is enabled.
emails	Array of objects	Email addresses of a user.
addresses	Array of objects	Addresses of a user.
phoneNumbers	Array of objects	Phone numbers of a user.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	Object	User work information.

**Table 11** meta
Parameter	Type	Description
resourceType	String	Resource type.
created	String	Resource creation time.
lastModified	String	Last resource update time.

**Table 12** name
Parameter	Type	Description
formatted	String	Formatted name to be displayed.
familyName	String	Family name of a user.
givenName	String	Given name of a user.
middleName	String	Middle name of a user.
honorificPrefix	String	Prefix of a user's name.
honorificSuffix	String	Suffix of a user's name.

**Table 13** emails
Parameter	Type	Description
value	String	Email address.
type	String	Email address type.
primary	Boolean	Whether the value is the user's primary email address.

**Table 14** addresses
Parameter	Type	Description
formatted	String	Formatted address to be displayed.
streetAddress	String	Street.
locality	String	Location.
region	String	Region.
postalCode	String	Postal code.
country	String	Country or region.
type	String	Address type.
primary	Boolean	Whether the address is the user's primary address.

**Table 15** phoneNumbers
Parameter	Type	Description
value	String	Phone number.
type	String	Phone number type.
primary	Boolean	Whether the value is the user's primary phone number.

**Table 16** urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
Parameter	Type	Description
costCenter	String	Cost Center. Minimum length: 1 Maximum length: 1024
department	String	Department. Minimum length: 1 Maximum length: 1024
division	String	Division. Minimum length: 1 Maximum length: 1024
employeeNumber	String	Employee ID. Minimum length: 1 Maximum length: 1024
manager	Object	Manager.
organization	String	Organization. Minimum length: 1 Maximum length: 1024

**Table 17** manager
Parameter	Type	Description
value	String	Manager. Minimum length: 1 Maximum length: 1024

Status code: 400

**Table 18** Parameters in the response body
Parameter	Type	Description
schema	String	Summary.
schemas	Array of strings	Summary list.
detail	String	Exception details.
status	Integer	Status code.
timeStamp	String	Timestamp.

Status code: 403

**Table 19** Parameters in the response body
Parameter	Type	Description
schema	String	Summary.
schemas	Array of strings	Summary list.
detail	String	Exception details.
status	Integer	Status code.
timeStamp	String	Timestamp.

Status code: 404

**Table 20** Parameters in the response body
Parameter	Type	Description
schema	String	Summary.
schemas	Array of strings	Summary list.
detail	String	Exception details.
status	Integer	Status code.
timeStamp	String	Timestamp.

Status code: 409

**Table 21** Parameters in the response body
Parameter	Type	Description
schema	String	Summary.
schemas	Array of strings	Summary list.
detail	String	Exception details.
status	Integer	Status code.
timeStamp	String	Timestamp.

Status code: 500

**Table 22** Parameters in the response body
Parameter	Type	Description
schema	String	Summary.
schemas	Array of strings	Summary list.
detail	String	Exception details.
status	Integer	Status code.
timeStamp	String	Timestamp.

Example Request

Creating a user

POST https://{hostname}/{tenant_id}/scim/v2/Users

{
  "externalId" : "123456",
  "userName" : "xxx",
  "name" : {
    "formatted" : "xxx",
    "familyName" : "xxx",
    "givenName" : "xxx",
    "middleName" : "xxx",
    "honorificPrefix" : "xxx",
    "honorificSuffix" : "xxx"
  },
  "displayName" : "xxx",
  "nickName" : "xxx",
  "profileUrl" : "xxx",
  "emails" : [ {
    "value" : "xxx",
    "type" : "work",
    "primary" : true
  } ],
  "addresses" : [ {
    "formatted" : "xxx",
    "streetAddress" : "xxx",
    "locality" : "xxx",
    "region" : "xxx",
    "postalCode" : "123456",
    "country" : "xxx",
    "type" : "work",
    "primary" : true
  } ],
  "phoneNumbers" : [ {
    "value" : "xxx",
    "type" : "work",
    "primary" : true
  } ],
  "userType" : "xxx",
  "title" : "xxx",
  "preferredLanguage" : "",
  "locale" : "",
  "timezone" : "xxx",
  "active" : true,
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ]
}

Example Response

Status code: 201

Successful

{
  "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
  "externalId" : "123456",
  "meta" : {
    "resourceType" : "User",
    "created" : "2023-04-08T14:53:43Z",
    "lastModified" : "2023-04-08T14:53:43Z"
  },
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "userName" : "xxx",
  "name" : {
    "formatted" : "xxx",
    "familyName" : "xxx",
    "givenName" : "xxx",
    "middleName" : "xxx",
    "honorificPrefix" : "xxx",
    "honorificSuffix" : "xxx"
  },
  "displayName" : "xxx",
  "nickName" : "xxx",
  "title" : "xxx",
  "userType" : "xxx",
  "preferredLanguage" : "",
  "locale" : "",
  "timezone" : "xxx",
  "active" : true,
  "emails" : [ {
    "value" : "xxx",
    "type" : "work",
    "primary" : true
  } ],
  "addresses" : [ {
    "formatted" : "xxx",
    "streetAddress" : "xxx",
    "locality" : "xxx",
    "region" : "xxx",
    "postalCode" : "123456",
    "country" : "xxx",
    "type" : "work",
    "primary" : true
  } ],
  "phoneNumbers" : [ {
    "value" : "xxx",
    "type" : "work",
    "primary" : true
  } ]
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Creating a User