reference.md

Management Organizations

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

🔌 Usage

await ssoReady.management.organizations.listOrganizations();

⚙️ Parameters

request: SSOReady.management.OrganizationsListOrganizationsRequest

requestOptions: Organizations.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

request: SSOReady.Organization

requestOptions: Organizations.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

requestOptions: Organizations.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

request: SSOReady.Organization

requestOptions: Organizations.RequestOptions

Management SamlConnections

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

🔌 Usage

await ssoReady.management.samlConnections.listSamlConnections();

⚙️ Parameters

request: SSOReady.management.SamlConnectionsListSamlConnectionsRequest

requestOptions: SamlConnections.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

request: SSOReady.SamlConnection

requestOptions: SamlConnections.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

requestOptions: SamlConnections.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

request: SSOReady.SamlConnection

requestOptions: SamlConnections.RequestOptions

Saml

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

🔌 Usage

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

⚙️ Parameters

request: SSOReady.RedeemSamlAccessCodeRequest

requestOptions: Saml.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

request: SSOReady.GetSamlRedirectUrlRequest

requestOptions: Saml.RequestOptions

Management ScimDirectories

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

🔌 Usage

await ssoReady.management.scimDirectories.listScimDirectories();

⚙️ Parameters

request: SSOReady.management.ScimDirectoriesListScimDirectoriesRequest

requestOptions: ScimDirectories.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

request: SSOReady.ScimDirectory

requestOptions: ScimDirectories.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

requestOptions: ScimDirectories.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

request: SSOReady.ScimDirectory

requestOptions: ScimDirectories.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

requestOptions: ScimDirectories.RequestOptions

Scim

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

🔌 Usage

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

⚙️ Parameters

request: SSOReady.ScimListScimGroupsRequest

requestOptions: Scim.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

requestOptions: Scim.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

request: SSOReady.ScimListScimUsersRequest

requestOptions: Scim.RequestOptions

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

🔌 Usage

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

⚙️ Parameters

id: string

requestOptions: Scim.RequestOptions

Management SetupUrls

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

🔌 Usage

await ssoReady.management.setupUrls.createSetupUrl();

⚙️ Parameters

request: SSOReady.management.CreateSetupUrlRequest

requestOptions: SetupUrls.RequestOptions