Sign in
Auth

Update OIDC groups-to-roles mapping

Changed on

Admin-only endpoint for updating the active Okta/OIDC groups claim and Cordum role mapping. Values are validated, applied to the live provider, and persisted into system/default config.

put/api/v1/auth/oidc/group-role-mapping

Request

  • Base URL: http://localhost:8081
  • URL: http://localhost:8081/api/v1/auth/oidc/group-role-mapping
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

X-Tenant-IDstring required

Tenant isolation header (required on all protected routes).

Request body

oidc_groups_claimstring

OIDC claim containing IdP group names.

oidc_group_role_mappingobject required

JSON object mapping Okta/OIDC group names to Cordum roles.

Response

Sanitized authentication configuration

password_enabledboolean
user_auth_enabledboolean
saml_enabledboolean
saml_enterpriseboolean
saml_login_urlstring
saml_metadata_urlstring
oidc_enabledboolean
oidc_issuerstring
oidc_login_urlstring
oidc_client_idstring
oidc_redirect_uristring
oidc_scopesstring[]
oidc_groups_claimstring

OIDC claim containing IdP group names, defaulting to groups.

oidc_group_role_mappingobject

Case-insensitive group name to Cordum role mapping.

oidc_client_secret_maskedstring
session_ttlstring
require_rbacboolean
require_principalboolean
default_tenantstring

Changes

  • 12120aad0bfeRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • d54165b78b6fRevision changes
    • info

      endpoint added