Post Post User
Creates a user in the system directory
Request
URI
POST
https://{api_host}//SAAS/jersey/manager/api/scim/Users
COPY
Query Parameters
string
attributes
Optional
list of attributes to return, separated by comma. When specified, the returned created user will only contain the minimal set of user attributes plus the attributes or sub-attributes explicitly requested
attributes example
urn:scim:schemas:extension:workspace:1.0:internalUserType,externalIdboolean
sendMail
Optional
whether or not to send email to set the password. This parameter is used only if the password is not set in the JSON body. If set to 'false', the returned user resource will contain an OTA link to set the password. The default is 'true'
sendMail example
false
Request Body
the user resource to be created as a JSON string
SdkUserResource of type(s) application/json
Required
{
"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"
}string
locale
Optional
locale
string
userType
Optional
userType
string
id
Optional
id
string
title
Optional
title
string
preferredLanguage
Optional
preferredLanguage
string
externalId
Optional
externalId
string
nickName
Optional
nickName
urn:scim:schemas:extension:workspace:1.0
Optional
urn:scim:schemas:extension:workspace:1.0
boolean
active
Optional
active
string
password
Optional
password
string
userName
Optional
userName
string
displayName
Optional
displayName
urn:scim:schemas:extension:enterprise:1.0
Optional
urn:scim:schemas:extension:enterprise:1.0
string
profileUrl
Optional
profileUrl
string
timeZone
Optional
timeZone
Responses
201
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"
}string
locale
Optional
locale
string
userType
Optional
userType
string
id
Optional
id
string
title
Optional
title
string
preferredLanguage
Optional
preferredLanguage
string
externalId
Optional
externalId
string
nickName
Optional
nickName
urn:scim:schemas:extension:workspace:1.0
Optional
urn:scim:schemas:extension:workspace:1.0
boolean
active
Optional
active
string
password
Optional
password
string
userName
Optional
userName
string
displayName
Optional
displayName
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 are invalid or the userName of the user to be created is missing or invalid
Operation doesn't return any data structure
409
A user with the same userName already exists
Operation doesn't return any data structure
500
An unexpected error occurred
Operation doesn't return any data structure
On This Page
Scim Operations
DELETE
Delete Delete Group
DELETE
Delete Delete User
GET
Get Get Group
GET
Get Get Groups
GET
Get Get Role
GET
Get Get Roles
GET
Get Get Schemas
GET
Get Get User
GET
Get Get Users
PATCH
Patch Patch Group
PATCH
Patch Patch Role
PATCH
Patch Patch User
POST
Post Find Groups
POST
Post Find Users
POST
Post Post Group
POST
Post Post User