Configure external identity providers for single sign-on and list available provider types.
/auth/identity-provider-typesList available identity provider types
Returns a list of identity provider types that organizations can configure. Only enabled and visible providers are returned.
Responses
Responses
A list of identity provider types is returned.
/auth/idpsList identity providers
Returns a paginated list of all identity providers configured for the organization, including their type, status, and issuer information.
Authorization
OrganizationAPI Key (header: LakeSail-Organization-Id)Parameters
limitinteger
The maximum number of items to list.
"int32"0100100markerstring
The pagination token returned from the previous list operation.
Responses
Responses
A list of identity providers is returned.
/auth/idpsCreate an identity provider
Configures a new external identity provider (e.g. Okta, Azure AD, Google Workspace) for single sign-on. Users can then authenticate through this provider to access the organization.
Request Body
Responses
Responses
The identity provider was created successfully.
/auth/idps/auto-setupAuto-setup identity provider
Discovers the OIDC configuration from the provider's base URL and automatically
registers LakeSail as an OAuth client using Dynamic Client Registration (RFC 7591).
The provider URL must be a fully-qualified URL including the scheme (http:// or https://).
Note: Not all identity providers support Dynamic Client Registration. The endpoint
will return an error if the provider does not support it.
Request Body
Responses
Responses
Identity provider was successfully auto-configured.
/auth/idps/{idp}Describe an identity provider
Returns the configuration details of an identity provider, including its type, issuer URL, and client settings.
Authorization
OrganizationAPI Key (header: LakeSail-Organization-Id)Responses
Responses
The information about the identity provider is returned.
/auth/idps/{idp}Delete an identity provider
Removes an identity provider configuration. Users who authenticated exclusively through this provider will need an alternative sign-in method.
Responses
Responses
The requested operation was done successfully.
/auth/idps/{idp}Update an identity provider
Modifies an identity provider's configuration, such as its display name, issuer URL, or client settings. Changes take effect for subsequent sign-in attempts.
Request Body
Responses
Responses
The identity provider was updated successfully.
/auth/idps/{idp}/rotate-secretRotate an identity provider's client secret
Updates the client secret for an identity provider. The new secret must be obtained
from the identity provider's admin console first.
Request Body
Responses
Responses
The client secret was rotated successfully.
/auth/idps/{idp}/test-connectionTest an identity provider connection
Validates the identity provider configuration by attempting to discover and fetch
the OIDC configuration from the provider's well-known endpoint.
Responses
Responses
The connection test result.