Skip to content

Latest commit

 

History

History
1136 lines (804 loc) · 14 KB

reference.md

File metadata and controls

1136 lines (804 loc) · 14 KB

Reference

Saml

client.Saml.RedeemSamlAccessCodeAsync(RedeemSamlAccessCodeRequest { ... }) -> RedeemSamlAccessCodeResponse

📝 Description

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

🔌 Usage

await client.Saml.RedeemSamlAccessCodeAsync(
    new RedeemSamlAccessCodeRequest { SamlAccessCode = "saml_access_code_..." }
);

⚙️ Parameters

request: RedeemSamlAccessCodeRequest

client.Saml.GetSamlRedirectUrlAsync(GetSamlRedirectUrlRequest { ... }) -> GetSamlRedirectUrlResponse

📝 Description

Gets a SAML initiation URL to redirect your users to.

🔌 Usage

await client.Saml.GetSamlRedirectUrlAsync(
    new GetSamlRedirectUrlRequest { OrganizationExternalId = "my_custom_external_id" }
);

⚙️ Parameters

request: GetSamlRedirectUrlRequest

Scim

client.Scim.ListScimGroupsAsync(ScimListScimGroupsRequest { ... }) -> ListScimGroupsResponse

📝 Description

Gets a list of SCIM groups in a SCIM directory.

🔌 Usage

await client.Scim.ListScimGroupsAsync(
    new ScimListScimGroupsRequest { OrganizationExternalId = "my_custom_external_id" }
);

⚙️ Parameters

request: ScimListScimGroupsRequest

client.Scim.GetScimGroupAsync(id) -> GetScimGroupResponse

📝 Description

Gets a SCIM group in a SCIM directory.

🔌 Usage

await client.Scim.GetScimGroupAsync("scim_group_...");

⚙️ Parameters

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

client.Scim.ListScimUsersAsync(ScimListScimUsersRequest { ... }) -> ListScimUsersResponse

📝 Description

Gets a list of SCIM users in a SCIM directory.

🔌 Usage

await client.Scim.ListScimUsersAsync(
    new ScimListScimUsersRequest { OrganizationExternalId = "my_custom_external_id" }
);

⚙️ Parameters

request: ScimListScimUsersRequest

client.Scim.GetScimUserAsync(id) -> GetScimUserResponse

📝 Description

Gets a SCIM user.

🔌 Usage

await client.Scim.GetScimUserAsync("scim_user_...");

⚙️ Parameters

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

Management Organizations

client.Management.Organizations.ListOrganizationsAsync(OrganizationsListOrganizationsRequest { ... }) -> ListOrganizationsResponse

📝 Description

Gets a list of organizations.

🔌 Usage

await client.Management.Organizations.ListOrganizationsAsync(
    new OrganizationsListOrganizationsRequest()
);

⚙️ Parameters

request: OrganizationsListOrganizationsRequest

client.Management.Organizations.CreateOrganizationAsync(Organization { ... }) -> CreateOrganizationResponse

📝 Description

Creates an organization.

🔌 Usage

await client.Management.Organizations.CreateOrganizationAsync(new Organization());

⚙️ Parameters

request: Organization

client.Management.Organizations.GetOrganizationAsync(id) -> GetOrganizationResponse

📝 Description

Gets an organization.

🔌 Usage

await client.Management.Organizations.GetOrganizationAsync("id");

⚙️ Parameters

id: string — ID of the organization to get.

client.Management.Organizations.UpdateOrganizationAsync(id, Organization { ... }) -> UpdateOrganizationResponse

📝 Description

Updates an organization.

🔌 Usage

await client.Management.Organizations.UpdateOrganizationAsync("id", new Organization());

⚙️ Parameters

id: string — ID of the organization to update.

request: Organization

Management SamlConnections

client.Management.SamlConnections.ListSamlConnectionsAsync(SamlConnectionsListSamlConnectionsRequest { ... }) -> ListSamlConnectionsResponse

📝 Description

Lists SAML connections in an organization.

🔌 Usage

await client.Management.SamlConnections.ListSamlConnectionsAsync(
    new SamlConnectionsListSamlConnectionsRequest()
);

⚙️ Parameters

request: SamlConnectionsListSamlConnectionsRequest

client.Management.SamlConnections.CreateSamlConnectionAsync(SamlConnection { ... }) -> CreateSamlConnectionResponse

📝 Description

Creates a SAML connection.

🔌 Usage

await client.Management.SamlConnections.CreateSamlConnectionAsync(new SamlConnection());

⚙️ Parameters

request: SamlConnection

client.Management.SamlConnections.GetSamlConnectionAsync(id) -> GetSamlConnectionResponse

📝 Description

Gets a SAML connection.

🔌 Usage

await client.Management.SamlConnections.GetSamlConnectionAsync("id");

⚙️ Parameters

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

client.Management.SamlConnections.UpdateSamlConnectionAsync(id, SamlConnection { ... }) -> UpdateSamlConnectionResponse

📝 Description

Updates a SAML connection.

🔌 Usage

await client.Management.SamlConnections.UpdateSamlConnectionAsync("id", new SamlConnection());

⚙️ Parameters

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

request: SamlConnection

Management ScimDirectories

client.Management.ScimDirectories.ListScimDirectoriesAsync(ScimDirectoriesListScimDirectoriesRequest { ... }) -> ListScimDirectoriesResponse

📝 Description

Gets a list of SCIM directories in an organization.

🔌 Usage

await client.Management.ScimDirectories.ListScimDirectoriesAsync(
    new ScimDirectoriesListScimDirectoriesRequest()
);

⚙️ Parameters

request: ScimDirectoriesListScimDirectoriesRequest

client.Management.ScimDirectories.CreateScimDirectoryAsync(ScimDirectory { ... }) -> CreateScimDirectoryResponse

📝 Description

Creates a SCIM directory.

🔌 Usage

await client.Management.ScimDirectories.CreateScimDirectoryAsync(new ScimDirectory());

⚙️ Parameters

request: ScimDirectory

client.Management.ScimDirectories.GetScimDirectoryAsync(id) -> GetScimDirectoryResponse

📝 Description

Gets a SCIM directory.

🔌 Usage

await client.Management.ScimDirectories.GetScimDirectoryAsync("id");

⚙️ Parameters

id: string — The ID of the SCIM directory.

client.Management.ScimDirectories.UpdateScimDirectoryAsync(id, ScimDirectory { ... }) -> UpdateScimDirectoryResponse

📝 Description

Updates a SCIM directory.

🔌 Usage

await client.Management.ScimDirectories.UpdateScimDirectoryAsync("id", new ScimDirectory());

⚙️ Parameters

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

request: ScimDirectory

client.Management.ScimDirectories.RotateScimDirectoryBearerTokenAsync(id) -> 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.RotateScimDirectoryBearerTokenAsync("id");

⚙️ Parameters

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

Management SetupUrls

client.Management.SetupUrls.CreateSetupUrlAsync(CreateSetupUrlRequest { ... }) -> 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.CreateSetupUrlAsync(new CreateSetupUrlRequest());

⚙️ Parameters

request: CreateSetupUrlRequest