Connections
Connection management
Get all connections
Create a new connection
Required Permissions:
sso_connection:write
Create a new connection with the provided details
path Parameters
organization_idOrganization ID
Create a new connection › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Create a new connection › Responses
Connection created successfully
created_atdescriptionemail_domainsidnameorganization_idpublic_namesaml_entity_idsaml_metadata_urlSessionSettings controls the session length for logins through this connection. Optional; nil preserves the existing value, non-nil overwrites.
typeupdated_atGet connection by ID
Required Permissions:
sso_connection:read
Retrieve a connection by its ID
path Parameters
organization_idOrganization ID
connection_idConnection ID to retrieve
Get connection by ID › Responses
Connection retrieved successfully
created_atdescriptionemail_domainsidnameorganization_idpublic_namesaml_entity_idsaml_metadata_urlSessionSettings controls the session length for logins through this connection. Optional; nil preserves the existing value, non-nil overwrites.
typeupdated_atUpdate connection
Required Permissions:
sso_connection:write
Update an existing connection
path Parameters
organization_idOrganization ID
connection_idConnection ID to update
Update connection › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Update connection › Responses
Connection updated successfully
created_atdescriptionemail_domainsidnameorganization_idpublic_namesaml_entity_idsaml_metadata_urlSessionSettings controls the session length for logins through this connection. Optional; nil preserves the existing value, non-nil overwrites.
typeupdated_at