reference.md

Reference

Saml

client.saml.redeemSamlAccessCode({ ...params }) -> SSOReady.RedeemSamlAccessCodeResponse

📝 Description

Exchanges a SAML access code for details about your user's SAML login details.

🔌 Usage

await client.saml.redeemSamlAccessCode({
    samlAccessCode: "saml_access_code_...",
});

⚙️ Parameters

request: SSOReady.RedeemSamlAccessCodeRequest

requestOptions: Saml.RequestOptions

client.saml.getSamlRedirectUrl({ ...params }) -> SSOReady.GetSamlRedirectUrlResponse

📝 Description

Gets a SAML initiation URL to redirect your users to.

🔌 Usage

await client.saml.getSamlRedirectUrl({
    organizationExternalId: "my_custom_external_id",
});

⚙️ Parameters

request: SSOReady.GetSamlRedirectUrlRequest

requestOptions: Saml.RequestOptions

Scim

client.scim.listScimGroups({ ...params }) -> SSOReady.ListScimGroupsResponse

📝 Description

Gets a list of SCIM groups in a SCIM directory.

🔌 Usage

await client.scim.listScimGroups({
    organizationExternalId: "my_custom_external_id",
});

⚙️ Parameters

request: SSOReady.ScimListScimGroupsRequest

requestOptions: Scim.RequestOptions

client.scim.getScimGroup(id) -> SSOReady.GetScimGroupResponse

📝 Description

Gets a SCIM group in a SCIM directory.

🔌 Usage

await client.scim.getScimGroup("scim_group_...");

⚙️ Parameters

id: string — ID of the SCIM group to get.

requestOptions: Scim.RequestOptions

client.scim.listScimUsers({ ...params }) -> SSOReady.ListScimUsersResponse

📝 Description

Gets a list of SCIM users in a SCIM directory.

🔌 Usage

await client.scim.listScimUsers({
    organizationExternalId: "my_custom_external_id",
});

⚙️ Parameters

request: SSOReady.ScimListScimUsersRequest

requestOptions: Scim.RequestOptions

client.scim.getScimUser(id) -> SSOReady.GetScimUserResponse

📝 Description

Gets a SCIM user.

🔌 Usage

await client.scim.getScimUser("scim_user_...");

⚙️ Parameters

id: string — ID of the SCIM user to get.

requestOptions: Scim.RequestOptions

Management Organizations

client.management.organizations.listOrganizations({ ...params }) -> SSOReady.ListOrganizationsResponse

📝 Description

Gets a list of organizations.

🔌 Usage

await client.management.organizations.listOrganizations();

⚙️ Parameters

request: SSOReady.management.OrganizationsListOrganizationsRequest

requestOptions: Organizations.RequestOptions

client.management.organizations.createOrganization({ ...params }) -> SSOReady.CreateOrganizationResponse

📝 Description

Creates an organization.

🔌 Usage

await client.management.organizations.createOrganization({});

⚙️ Parameters

request: SSOReady.Organization

requestOptions: Organizations.RequestOptions

client.management.organizations.getOrganization(id) -> SSOReady.GetOrganizationResponse

📝 Description

Gets an organization.

🔌 Usage

await client.management.organizations.getOrganization("id");

⚙️ Parameters

id: string — ID of the organization to get.

requestOptions: Organizations.RequestOptions

client.management.organizations.updateOrganization(id, { ...params }) -> SSOReady.UpdateOrganizationResponse

📝 Description

Updates an organization.

🔌 Usage

await client.management.organizations.updateOrganization("id", {});

⚙️ Parameters

id: string — ID of the organization to update.

request: SSOReady.Organization

requestOptions: Organizations.RequestOptions

Management SamlConnections

client.management.samlConnections.listSamlConnections({ ...params }) -> SSOReady.ListSamlConnectionsResponse

📝 Description

Lists SAML connections in an organization.

🔌 Usage

await client.management.samlConnections.listSamlConnections();

⚙️ Parameters

request: SSOReady.management.SamlConnectionsListSamlConnectionsRequest

requestOptions: SamlConnections.RequestOptions

client.management.samlConnections.createSamlConnection({ ...params }) -> SSOReady.CreateSamlConnectionResponse

📝 Description

Creates a SAML connection.

🔌 Usage

await client.management.samlConnections.createSamlConnection({});

⚙️ Parameters

request: SSOReady.SamlConnection

requestOptions: SamlConnections.RequestOptions

client.management.samlConnections.getSamlConnection(id) -> SSOReady.GetSamlConnectionResponse

📝 Description

Gets a SAML connection.

🔌 Usage

await client.management.samlConnections.getSamlConnection("id");

⚙️ Parameters

id: string — ID of the SAML connection to get.

requestOptions: SamlConnections.RequestOptions

client.management.samlConnections.updateSamlConnection(id, { ...params }) -> SSOReady.UpdateSamlConnectionResponse

📝 Description

Updates a SAML connection.

🔌 Usage

await client.management.samlConnections.updateSamlConnection("id", {});

⚙️ Parameters

id: string — The ID of the SAML connection to update.

request: SSOReady.SamlConnection

requestOptions: SamlConnections.RequestOptions

Management ScimDirectories

client.management.scimDirectories.listScimDirectories({ ...params }) -> SSOReady.ListScimDirectoriesResponse

📝 Description

Gets a list of SCIM directories in an organization.

🔌 Usage

await client.management.scimDirectories.listScimDirectories();

⚙️ Parameters

request: SSOReady.management.ScimDirectoriesListScimDirectoriesRequest

requestOptions: ScimDirectories.RequestOptions

client.management.scimDirectories.createScimDirectory({ ...params }) -> SSOReady.CreateScimDirectoryResponse

📝 Description

Creates a SCIM directory.

🔌 Usage

await client.management.scimDirectories.createScimDirectory({});

⚙️ Parameters

request: SSOReady.ScimDirectory

requestOptions: ScimDirectories.RequestOptions

client.management.scimDirectories.getScimDirectory(id) -> SSOReady.GetScimDirectoryResponse

📝 Description

Gets a SCIM directory.

🔌 Usage

await client.management.scimDirectories.getScimDirectory("id");

⚙️ Parameters

id: string — The ID of the SCIM directory.

requestOptions: ScimDirectories.RequestOptions

client.management.scimDirectories.updateScimDirectory(id, { ...params }) -> SSOReady.UpdateScimDirectoryResponse

📝 Description

Updates a SCIM directory.

🔌 Usage

await client.management.scimDirectories.updateScimDirectory("id", {});

⚙️ Parameters

id: string — The ID of the SCIM directory to update.

request: SSOReady.ScimDirectory

requestOptions: ScimDirectories.RequestOptions

client.management.scimDirectories.rotateScimDirectoryBearerToken(id) -> SSOReady.RotateScimDirectoryBearerTokenResponse

📝 Description

Rotates a SCIM directory's bearer token.

Every SCIM directory has a bearer token that SSOReady uses to authenticate requests sent from your customer's Identity Provider. These bearer tokens are assigned by SSOReady, and are secret. Newly-created SCIM directories do not have any bearer token at all; you must use this endpoint to get an initial value.

Rotating a SCIM directory bearer token immediately invalidates the previous bearer token, if any. Your customer will need to update their SCIM configuration with the new value to make SCIM syncing work again.

SSOReady only stores the hash of these bearer tokens. If your customer has lost their copy, you must use this endpoint to generate a new one.

🔌 Usage

await client.management.scimDirectories.rotateScimDirectoryBearerToken("id");

⚙️ Parameters

id: string — The ID of the SCIM directory whose bearer token to rotate.

requestOptions: ScimDirectories.RequestOptions

Management SetupUrls

client.management.setupUrls.createSetupUrl({ ...params }) -> SSOReady.CreateSetupUrlResponse

📝 Description

Creates a short-lived self-serve setup URL that you can send to your customer.

Setup URLs let your customer configure their SAML settings, SCIM settings, or both.

🔌 Usage

await client.management.setupUrls.createSetupUrl();

⚙️ Parameters

request: SSOReady.management.CreateSetupUrlRequest

requestOptions: SetupUrls.RequestOptions