Single Sign-On (SSO) REST API
List SSO domains for an organization
⚠️ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.
➕ Bencher Plus: List all single sign-on (SSO) domains for an organization. The user must be a member of the organization to use this route.
Headers
Content-Type string
Set to application/json.
Authorization string
Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).
Path Parameters
organizationThe slug or UUID for an organization.
Query Parameters
directionstring
The direction to sort by. If not specified, the default sort direction is used.
Default: asc
One of: asc, desc
pageinteger
The page number to return. If not specified, the first page is returned.
Default: 1
per_pageinteger
The number of items to return per page. If not specified, the default number of items per page (8) is used.
Default: 8
sortstring
The field to sort by. If not specified, the default sort field is used.
Default: domain
One of: domain
/v0/organizations/{organization}/sso | Bencher Cloud | https://api.bencher.dev |
| Bencher Self-Hosted | http://localhost:6610 |
Bencher CLI
bencher sso list ORGANIZATION View OpenAPI Spec
Add an SSO domain to an organization
⚠️ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.
➕ Bencher Plus: Add a single sign-on (SSO) domain to an organization. The user must be an admin on the server to use this route. When a user authenticates with the server, the domain portion of their email will be compared against all SSO domains. If an SSO domain matches, they will be added as a Member to that Organization. SSO domains must be globally unique on the server. That is, two Organizations cannot have the same SSO domain.
Headers
Content-Type string
Set to application/json.
Authorization string
Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).
Path Parameters
organizationThe slug or UUID for an organization.
Body Parameters
domainstring
The SSO domain. For example: example.com
/v0/organizations/{organization}/sso | Bencher Cloud | https://api.bencher.dev |
| Bencher Self-Hosted | http://localhost:6610 |
Bencher CLI
bencher sso create ORGANIZATION View OpenAPI Spec
View an SSO domain for an organization
⚠️ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.
➕ Bencher Plus: View a single sign-on (SSO) domain from an organization. The user must be a member of the organization to use this route.
Headers
Content-Type string
Set to application/json.
Authorization string
Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).
Path Parameters
organizationThe slug or UUID for an organization.
ssostring
The UUID for an SSO domain.
/v0/organizations/{organization}/sso/{sso} | Bencher Cloud | https://api.bencher.dev |
| Bencher Self-Hosted | http://localhost:6610 |
Bencher CLI
bencher sso view ORGANIZATION SSO View OpenAPI Spec
Remove an SSO domain from an organization
⚠️ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.
➕ Bencher Plus: Remove a single sign-on (SSO) domain from an organization. The user must be an admin on the server to use this route.
Headers
Content-Type string
Set to application/json.
Authorization string
Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).
Path Parameters
organizationThe slug or UUID for an organization.
ssostring
The UUID for an SSO domain.
/v0/organizations/{organization}/sso/{sso} | Bencher Cloud | https://api.bencher.dev |
| Bencher Self-Hosted | http://localhost:6610 |
Bencher CLI
bencher sso delete ORGANIZATION SSO View OpenAPI Spec