Skip to content
API Enriched

Create User with Role Assignment.

POST
/api/scim/namespaces/system/v2/Users
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/scim/namespaces/system/v2/Users \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "active": true, "displayName": "example", "emails": [ { "primary": true, "type": "example", "value": "example" } ], "externalId": "example", "groups": [ { "display": "example", "id": "example" } ], "meta": { "created": "example", "lastModified": "example", "location": "example", "resourceType": "example", "version": "example" }, "name": { "familyName": "example", "formatted": "example", "givenName": "example", "honorificPrefix": "example", "honorificSuffix": "example", "middleName": "example" }, "roles": [ "example" ], "schemas": [ "example" ], "userName": "example", "userType": "USER" }'

Create creates a user and namespace roles binding for this user.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateUserRequest

CreateUserRequest is the request for creating a user.

object
active
active

Active is boolean representing if user is active or not.

boolean format: boolean
displayName
displayName

DisplayName refers to the name to be displayed for the user. Default is name.

string
<= 1024 characters
emails
emails

Emails can be list of emails to be used by user work, personal etc.

Array<object>
Email

Email for user can be primary or secondary.

object
primary
primary

Primary boolean describing whether it is primary or not.

boolean format: boolean
type
type

Type of email describing whether it is work or personal.

string
<= 1024 characters
value
value

Value.

string
>= 3 characters <= 1024 characters
externalId
externalId

ExternalId refers to the ID for user represented in the external system like Azure etc.

string
<= 1024 characters
groups
groups

Groups to which user belongs to.

Array<object>
UserGroup

UserGroup.

object
display
display

Display for the user group name.

string
<= 1024 characters
id
id

ID of the group to which user belongs.

string
>= 1 <= 4094 <= 1024 characters
meta
object
created
created

Create date. Required: YES.

string
<= 1024 characters
lastModified
lastModified

Last modification date and time. Required: YES.

string
<= 1024 characters
location
location

[x-required] location for resource.

string
>= 4 characters <= 1024 characters
resourceType
resourceType

Type of resource. Required: YES.

string
<= 1024 characters
version
version

Version for resource type. Required: YES.

string
>= 1 characters <= 1024 characters
name
object
familyName
familyName

Family name.

string
<= 1024 characters
formatted
formatted

Formatted name is detailed name of person.

string
<= 1024 characters
givenName
givenName

Given name of the person.

string
<= 1024 characters
honorificPrefix
honorificPrefix

Prefix for the name. Mr Ms. Etc.

string
<= 1024 characters
honorificSuffix
honorificSuffix

Suffix for the name like Jr Sr I II III etc.

string
<= 1024 characters
middleName
middleName

Middle name of the person.

string
<= 1024 characters
roles
roles

Roles defined for the user. Required: YES.

Array<string>
schemas
schemas

Schemas represent the schema from scim spec to be used for creating the user.

Array<string>
userName
userName

UserName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.

string
<= 1024 characters
userType
string
default: USER
Allowed values: USER SERVICE DEBUG

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
User

User object representing the user created.

object
active
active

Active specifies if user is active or not.

boolean format: boolean
displayName
displayName

DisplayName for the user.

string
<= 1024 characters
emails
emails

Emails for the user whether primary or secondary.

Array<object>
Email

Email for user can be primary or secondary.

object
primary
primary

Primary boolean describing whether it is primary or not.

boolean format: boolean
type
type

Type of email describing whether it is work or personal.

string
<= 1024 characters
value
value

Value.

string
>= 3 characters <= 1024 characters
externalId
externalId

ExternalId specifies the ID for the user object in external system. Required: YES.

string
<= 1024 characters
groups
groups

Groups to which user is part of. Required: YES.

Array<object>
UserGroup

UserGroup.

object
display
display

Display for the user group name.

string
<= 1024 characters
id
id

ID of the group to which user belongs.

string
>= 1 <= 4094 <= 1024 characters
id
id

ID for user object. Required: YES.

string
>= 1 <= 4094 <= 1024 characters
meta
object
created
created

Create date. Required: YES.

string
<= 1024 characters
lastModified
lastModified

Last modification date and time. Required: YES.

string
<= 1024 characters
location
location

[x-required] location for resource.

string
>= 4 characters <= 1024 characters
resourceType
resourceType

Type of resource. Required: YES.

string
<= 1024 characters
version
version

Version for resource type. Required: YES.

string
>= 1 characters <= 1024 characters
name
object
familyName
familyName

Family name.

string
<= 1024 characters
formatted
formatted

Formatted name is detailed name of person.

string
<= 1024 characters
givenName
givenName

Given name of the person.

string
<= 1024 characters
honorificPrefix
honorificPrefix

Prefix for the name. Mr Ms. Etc.

string
<= 1024 characters
honorificSuffix
honorificSuffix

Suffix for the name like Jr Sr I II III etc.

string
<= 1024 characters
middleName
middleName

Middle name of the person.

string
<= 1024 characters
nickName
nickName

NickName for the user.

string
<= 1024 characters
roles
roles

Roles defined for the user. Required: YES.

Array<string>
schemas
schemas

Schemas for user object as per scim spec 2.0. Required: YES.

Array<string>
userName
userName

UserName for the user. Required: YES.

string
<= 1024 characters
userType
string
default: USER
Allowed values: USER SERVICE DEBUG
Example
{
  "userType": "USER"
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example