ScimUser
A SCIM user: a person as the organization's identity provider knows them.
Shape
- userNamestringThe person's sign-in name — for gitmoap, their email address.
- activebooleanoptional
falsetakes away the person's access to the organization;truegives it back. - displayNamestring or nulloptional
emailsarray of ScimEmailoptional
- The ScimEmail schema
- valuestring
- primaryboolean or nulloptional
- typestring or nulloptional
- externalIdstring or nulloptional
groupsarray of ScimMemberRefoptionalThe groups the person is in. Read-only: groups are changed through the group.
- The ScimMemberRef schema
- valuestringThe id of the user or group.
- displaystring or nulloptional
- idstring or nulloptional
metaScimMeta or nulloptional
- The ScimMeta schema
- createdstring · date-time
- lastModifiedstring · date-time
- locationstring
- resourceTypestring
nameScimName or nulloptional
- The ScimName schema
- familyNamestring or nulloptional
- formattedstring or nulloptional
- givenNamestring or nulloptional
- schemasarray of stringoptional
Example
Synthesized example{
"userName": "userName-feb0",
"active": true,
"displayName": "displayName-7089",
"emails": [
{
"value": "value-8e79"
}
],
"externalId": "externalId-a64b",
"groups": [
{
"value": "value-de3e"
},
{
"value": "value-5268"
}
],
"id": "id-eb61",
"meta": {
"created": "2026-10-08T18:22:13Z",
"lastModified": "2026-10-14T01:39:22Z",
"location": "location-8f43",
"resourceType": "resourceType-46ca"
},
"name": {
"familyName": "familyName-0423",
"formatted": "formatted-c722",
"givenName": "givenName-ec8b"
},
"schemas": [
"schemas-7e28",
"schemas-c3dc"
]
}
Graph
Used inside
Used by
Sent by 2 operations
Returned by 4 operations
- POSTProvision a person./scim/v2/organizations/{group_id}/Users
- GETOne person the identity provider pushed./scim/v2/organizations/{group_id}/Users/{scim_user_id}
- PUTReplace a person's attributes; `active: false` de-provisions them./scim/v2/organizations/{group_id}/Users/{scim_user_id}
- PATCHChange some of a person's attributes; `active: false` de-provisions them./scim/v2/organizations/{group_id}/Users/{scim_user_id}