Sign in

v1

latestOpenAPI 3.0.42026-08-064075233.0 KB
IdentityProviders

Create a new identity provider

Creates a new identity provider for the specified organization.

post/api/organizations/{organizationId}/identityproviders

Path parameters

organizationIdstring uuid required

The identifier for the organization that the identity provider belongs to.

Request body

idstring uuid

Unique identifier for the identity provider.

namestring nullable

Name of the identity provider.

descriptionstring nullable

Description of the identity provider.

organizationIdstring uuid

Unique identifier for the organization.

crosserRolestring nullable

The role required in the identity provider that external users must have to log in to the Crosser system.

clientIdstring nullable

Client ID for the identity provider.

clientSecretstring nullable

Client secret for the identity provider.

callbackPathstring nullable

Callback path for the identity provider.

authoritystring nullable

Authority URL for the identity provider.

userNameClaimstring nullable

Claim used for the username.

disabledboolean

Indicates if the identity provider is disabled.

debugboolean

Indicates if debug mode is enabled.

getClaimsFromUserInfoEndpointboolean

Indicates if claims should be retrieved from the user info endpoint.

domainsstring[] nullable

List of domains associated with the identity provider.

scopesstring[] nullable

List of scopes for the identity provider.

roleClaimsstring[] nullable

List of role claims for the identity provider.

roleMappingsobject nullable

Dictionary of role mappings for the identity provider.

Example request

{
  "id": "4100b683-bde7-40c8-bc9c-97c293913f7f",
  "name": "My Identity Provider",
  "description": "This is a sample identity provider.",
  "organizationId": "8b3d1b78-00c8-4b4a-8874-d5771048d750",
  "crosserRole": "Admin",
  "clientId": "client-id-123",
  "clientSecret": "super-secret",
  "callbackPath": "/auth/callback",
  "authority": "https://authority.example.com",
  "userNameClaim": "preferred_username",
  "debug": true,
  "getClaimsFromUserInfoEndpoint": true,
  "domains": [
    "example.com",
    "another-example.com"
  ],
  "scopes": [
    "openid",
    "profile",
    "email"
  ],
  "roleClaims": [
    "admin",
    "user"
  ],
  "roleMappings": {
    "external-role-1": [
      "internal-role-1",
      "internal-role-2"
    ],
    "external-role-2": [
      "internal-role-3"
    ]
  }
}

Response

OK