Globally unique UUID that identifies a specific Organization. The organization_id is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
SCIM Connection Object
Fields
organization_id string
connection_id string
The ID of the SCIM connection.
status string
The status of the connection. The possible values are deleted or active.
display_name string
A human-readable display name for the connection.
identity_provider string
Name of the IdP. Enum with possible values: okta, microsoft-entra, cyberark, jumpcloud, onelogin, pingfederate, rippling or generic.
Specifying a known provider allows Stytch to handle any provider-specific logic, such as automatically appending ?aadOptscim062020 to the returned BaseURL for microsoft-entra SCIM Connections to enable the SCIM 2.0 compliant flag.
base_url string
The URL supplied to the Identity Provider (IdP) alongside the bearer token enabling access to Stytch's SCIM API endpoints
bearer_token string
The token supplied to the Identity Provider (IdP) alongside the base URL that grants access to Stytch's SCIM API endpoints. It should be included in HTTP authorization headers. This field is supplied only on creation of the SCIM connection.
bearer_token_expires_at timestamp
The bearer token expiry time.
bearer_token_last_four string
The last four digits of the bearer token. If you've lost access to your bearer_token and need to generate a new one, use the SCIM rotate token start endpoint.
next_bearer_token string
This field is supplied only during token rotation. This token should be used as the new bearer token for the SCIM connection after token rotation has been completed using the SCIM rotate token complete endpoint.
next_bearer_token_expires_at timestamp
This field is supplied only during token rotation. The next bearer token expiry time.
scim_group_implicit_role_assignments array[objects]
An array of SCIM group implicit role assignments. Each object in the array must contain a group_id and a role_id.
group_id string
The ID of the group.
role_id string
The ID of the role.
OBJECT 200
{
"connection": {
"organization_id": "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931"
"connection_id": "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc"
"status": "active",
"display_name": "My SCIM Connection"
"identity_provider": "okta"
"base_url": "https://test.stytch.com/v1/b2b/scim/scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc"
"bearer_token": "9LmcAfUxGGMSNzfROGY762wTD3A6DQsD3hmxbrAJaEjTsdko"
"bearer_token_last_four": "sdko"
"bearer_token_expires_at": "2029-03-20T21:28:28Z"
"next_bearer_token": "8TqbGcJyFFLSNveQPGZ861xSE2B7CPtC2gnyasAIbDiUrcjn"
"next_bearer_token_expires_at": "2030-03-20T21:28:28Z"
"scim_implicit_role_assignments": [
{
"role_id": "example_role_id",
"group_id": "scim-group-test-5c44cc6a-8af7-48d6-8da7-ea821342f5a6",
}
],
},
}