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.
External Connection object
Fields
organization_id string
connection_id string
Globally unique UUID that identifies a specific External SSO Connection.
display_name string
A human-readable display name for the connection.
external_organization_id string
Globally unique UUID that identifies a different Organization within your Project.
external_connection_id string
Globally unique UUID that identifies a specific SSO connection configured for a different Organization in your Project.
external_connection_implicit_role_assignments array[object]
All Members who log in with this External connection will implicitly receive the specified Roles. See the RBAC guide for more information about role assignment. Implicit role assignments are not supported for External connections if the underlying SSO connection is an OIDC connection.
role_id string
The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable.
Reserved role_ids that are predefined by Stytch include:
- stytch_member
- stytch_admin
Check out the guide on Stytch default Roles for a more detailed explanation.
external_group_implicit_role_assignments array[object]
Defines the names of the groups that grant specific role assignments. For each group-Role pair, if a Member logs in with this external connection and belongs to the specified group, they will be granted the associated Role. See the RBAC guide for more information about role assignment.
group string
The name of the group that grants the specified role assignment.
role_id string
The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable.
Reserved role_ids that are predefined by Stytch include:
- stytch_member
- stytch_admin
Check out the guide on Stytch default Roles for a more detailed explanation.
status string
The status of the connection. External connections are always active.
OBJECT 200
{
"connection": {
"connection_id": "external-connection-test-5c44cc6a-8af7-48d6-8da7-ea821342f5a6",
"display_name": "Example External Connection",
"organization_id": "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
"external_organization_id": "organization-test-ca6dbe77-10e5-4403-805a-b117c55c24c6",
"external_connection_id": "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
"external_connection_implicit_role_assignments": [
{
"role_id": "admin"
}
],
"external_group_implicit_role_assignments": [
{
"role_id": "editor",
"group": "editors"
},
{
"role_id": "reader",
"group": "readers"
}
],
"status": "active",
},
}