Organization SCIM API differences (Preview)¶
Organization-scoped SCIM uses the same /scim/v2/ endpoints as account-scoped SCIM. HTTP headers, the base URL, pagination, filters, and request examples are in the user API reference and the group API reference. This page lists the attributes Snowflake supports for an organization user and an organization user group, and the privilege each endpoint checks.
Create the integration with Provision organization users and organization user groups with SCIM (Preview).
Organization user attributes¶
For an account user, MAP_SCIM_USERNAME_TO_ENTERPRISE_ATTR chooses whether userName maps to NAME or to LOGIN_NAME. For an organization user, userName is always LOGIN_NAME. NAME is snowflakeUserName, or userName when snowflakeUserName is omitted.
Organization users don’t have a password.
The following table lists the organization user attributes that Snowflake supports:
| SCIM User Attribute | Snowflake User Attribute | Type | Description |
|---|---|---|---|
id | Assigned by Snowflake | string | The immutable, unique identifier of the organization user. Use this value as members.value when you add the user to an organization user group. Snowflake doesn’t return this value in the SHOW ORGANIZATION USERS output. |
userName | LOGIN_NAME | string | The identifier used to log in to Snowflake. This property can’t be changed after the user is created. An update with a value that differs only in case is accepted, and that value is returned in the response. LOGIN_NAME is stored in uppercase. An update that changes userName to any other value returns HTTP 400. |
name.givenName | FIRST_NAME | string | The first name of the user. |
name.middleName | MIDDLE_NAME | string | The middle name of the user. |
name.familyName | LAST_NAME | string | The last name of the user. |
emails | EMAIL | string | The email address of the user. This is a required property. A request that removes emails returns HTTP 400. |
displayName | DISPLAY_NAME | string | The text shown in the user interface when referring to the user. |
externalId | N/A | string | The unique identifier set by the provisioning client, such as Microsoft Entra ID or Okta. |
active | DISABLED | boolean | Disables the user when set to false. A PUT that omits active enables the user. |
groups | N/A | string | A list of groups to which the user belongs. The group displayName is required. |
meta.created | CREATED_ON | string | The time the user was added to Snowflake. |
meta.lastModified | UPDATED_ON | string | The time the user was last modified in Snowflake. |
meta.resourceType | N/A | string | The type of resource. The value is User. |
schemas | N/A | string | An array of strings specifying the namespace URIs. Snowflake supports the following values:
|
Custom attributes¶
Use the same namespaces as Custom attributes.
The following table lists the custom attributes that Snowflake supports for an organization user:
| SCIM User Custom Attribute | Snowflake User Attribute | Type | Description |
|---|---|---|---|
snowflakeUserName | NAME | string | The Snowflake identifier of the user. This property can’t be changed after the user is created. A value that differs only by casing is accepted, and the original value is preserved. When omitted on create, NAME is set from userName. An unquoted value is stored uppercased. A quoted value keeps its case. |
allowedInterfaces | ALLOWED_INTERFACES | string | Defines which Snowflake interfaces the user can access. Specified as a comma-delimited list of interfaces. If a value other than ALL is specified, then users can only access the interface specified and can’t interact with any Snowflake data outside of the interface specified. |
defaultWarehouse | DEFAULT_WAREHOUSE | string | The virtual warehouse that is active by default for the user’s session upon login. |
defaultRole | DEFAULT_ROLE | string | The primary role that is active by default for the user’s session upon login. |
defaultSecondaryRoles | DEFAULT_SECONDARY_ROLES | string | The list of secondary roles that are active for the user’s session upon login. You can set this
attribute to |
type | TYPE | string | The type of the organization user. You can set this attribute to either PERSON or SERVICE. For what SERVICE changes, see Organization user types. |
Organization user endpoints¶
You manage organization users through the same SCIM endpoints as account-scoped SCIM. See the user API reference. A missing privilege returns HTTP 403. A list or a userName lookup without MANAGE ORGANIZATION USERS returns no users.
The following table lists the privilege that each endpoint checks:
| Endpoint | Privilege |
|---|---|
GET /Users and GET /Users?filter=userName eq "..." | MANAGE ORGANIZATION USERS |
GET /Users/{id} | MANAGE ORGANIZATION USERS |
POST /Users | CREATE ORGANIZATION USER |
PATCH /Users/{id} and PUT /Users/{id} | MANAGE ORGANIZATION USERS |
DELETE /Users/{id} | MANAGE ORGANIZATION USERS |
GET /Users returns a page of organization users. With MANAGE ORGANIZATION USERS, the query matches every organization user in the organization. totalResults is the number of matching organization users, including users that aren’t on this page. This differs from account-scoped SCIM, where totalResults equals startIndex + count when another page is available. See the user API reference.
GET /Users?filter=userName eq "..." uppercases the filter value and matches that LOGIN_NAME. userName sw uppercases the filter value and matches a LOGIN_NAME that starts with it. LOGIN_NAME is stored in uppercase. The filter doesn’t also search for the original casing.
DELETE /Users/{id} drops the organization user. See Removing users from all regular accounts.
Organization user group attributes¶
In organization-scoped SCIM, every SCIM group is an organization user group.
The following table lists the organization user group attributes that Snowflake supports:
| SCIM Group Attribute | Snowflake Group Attribute | Type | Description |
|---|---|---|---|
id | Assigned by Snowflake | string | The immutable, unique identifier of the organization user group. Snowflake doesn’t return this value in the SHOW ORGANIZATION USER GROUPS output. |
displayName | NAME | string | The text shown in the user interface when referring to the group. This property can’t be changed after the group is created. A value that differs only by casing is allowed, but the original value is preserved from creation time. Any other value returns HTTP 400. |
members.value | N/A | string | The id of an organization user who is a member of the group. Any other id returns HTTP 400. A group can’t be a member of a group. |
schemas | N/A | string | An array of strings that indicates the namespace URIs. For example, urn:ietf:params:scim:schemas:core:2.0:Group. |
Import adds the group’s users to the regular account and creates a role with the group’s name. See Import the group in a regular account and Resolve conflicts after importing users.
IS_GRANTABLE and VISIBILITY aren’t SCIM-settable attributes. Set IS_GRANTABLE and VISIBILITY with ALTER ORGANIZATION USER GROUP.
Organization user group endpoints¶
You manage organization user groups through the same SCIM group API endpoints as account-scoped SCIM. See the group API reference. A missing privilege returns HTTP 403. A list or a displayName lookup without MANAGE ORGANIZATION USER GROUPS returns no groups.
The following table lists the privilege that each endpoint checks:
| Endpoint | Privilege |
|---|---|
GET /Groups and GET /Groups?filter=displayName eq "..." | MANAGE ORGANIZATION USER GROUPS |
GET /Groups/{id} | MANAGE ORGANIZATION USER GROUPS |
POST /Groups | CREATE ORGANIZATION USER GROUP |
PATCH /Groups/{id} | MANAGE ORGANIZATION USER GROUPS |
DELETE /Groups/{id} | MANAGE ORGANIZATION USER GROUPS |
GET /Groups returns a page of organization user groups. With MANAGE ORGANIZATION USER GROUPS, the query matches every organization user group in the organization. totalResults is the number of matching organization user groups, including groups that aren’t on this page. This differs from account-scoped SCIM, where totalResults equals startIndex + count when another page is available. See the group API reference.
displayName eq and displayName sw work the same way as in the group API reference. eq matches the value as sent, as well as the uppercased displayName. sw matches the value as sent, and that comparison is case-sensitive. excludedAttributes=members also works the same way as in the group API reference.
DELETE /Groups/{id} drops the organization user group. See Removing users from all regular accounts.