User
SCIM User resource as defined in RFC 7643 Section 4.1. Represents a user account in the system.
Indicates the user's administrative status. Typically true means able to log in, false means account suspended
addresses object[]
Physical mailing addresses for the user
The country name in ISO 3166-1 alpha-2 format
The full mailing address, formatted for display
The city or locality component
The zip code or postal code component
Indicates if this is the primary address
The state or region component
The full street address component
The type of address (work, home, other)
The name of the user, suitable for display to end-users
emails object[]
Email addresses for the user
A human-readable name for the email address
Indicates if this is the primary email address
The type of email address (work, home, other)
The email address value
Identifier for the user as defined by the provisioning client. Allows the client to maintain their own identifier.
groups object[]
Groups to which the user belongs
The URI of the corresponding Group resource
A human-readable name for the group
The type of group membership
The identifier of the group
Unique identifier for the user. Assigned by the service provider. MUST be unique across the entire set of resources. Immutable.
The user's default location for purposes of localizing items such as currency and date/time format. Valid value is a language tag as defined in RFC 5646
meta object
Resource metadata as defined in RFC 7643 Section 3.1
The timestamp when the resource was created
The timestamp when the resource was last modified
The URI of the resource
The name of the resource type (e.g., User, Group)
The version of the resource. Used for ETag-based versioning. Weak ETags are prefixed with W/
name object
The components of the user's name
The family name (last name) of the user
The full name, including all middle names, titles, and suffixes
The given name (first name) of the user
The honorific prefix(es) of the user (e.g., Ms., Dr.)
The honorific suffix(es) of the user (e.g., III, Jr.)
The middle name(s) of the user
The casual way to address the user
phoneNumbers object[]
Phone numbers for the user
A human-readable name for the phone number
Indicates if this is the primary phone number
The type of phone number (work, home, mobile, fax, pager, other)
The phone number in E.164 format (e.g., tel:+1-201-555-0123)
The user's preferred written or spoken languages. Format as defined in RFC 7231 Section 5.3.5
A URI pointing to the user's online profile
The schema URIs that define this resource
Possible values: [urn:ietf:params:scim:schemas:core:2.0:User]
The user's time zone in IANA Time Zone database format
The user's title, such as Vice President
Unique identifier for the user, typically used for authentication. Often the user's email address. REQUIRED. Case insensitive.
Identifies the relationship between the organization and the user. Typical values: Contractor, Employee, Intern, Temp, External
{
"active": true,
"addresses": [
{
"country": "string",
"formatted": "string",
"locality": "string",
"postalCode": "string",
"primary": true,
"region": "string",
"streetAddress": "string",
"type": "string"
}
],
"displayName": "string",
"emails": [
{
"display": "string",
"primary": true,
"type": "string",
"value": "user@example.com"
}
],
"externalId": "string",
"groups": [
{
"$ref": "string",
"display": "string",
"type": "string",
"value": "string"
}
],
"id": "string",
"locale": "string",
"meta": {
"created": "2024-07-29T15:51:28.071Z",
"lastModified": "2024-07-29T15:51:28.071Z",
"location": "string",
"resourceType": "string",
"version": "string"
},
"name": {
"familyName": "string",
"formatted": "string",
"givenName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"middleName": "string"
},
"nickName": "string",
"phoneNumbers": [
{
"display": "string",
"primary": true,
"type": "string",
"value": "string"
}
],
"preferredLanguage": "string",
"profileUrl": "string",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"timezone": "string",
"title": "string",
"userName": "string",
"userType": "string"
}