SSO Configs

Create a new SSO Config.

Changed on Nov 6, 2026

To create a new SSO Config, send a POST request to /v1/tenants/$TENANT_ID/realms/$REALM_ID/sso-configs.

post/v1/tenants/{tenant_id}/realms/{realm_id}/sso-configs

Request

Base URL
https://api-us.beyondidentity.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/docs/v1/tenants/:tenant_id/realms/:realm_id/sso-configs/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-correlation_idstring required

Correlation ID. If supplied with the request, the response must contain the same value. If not supplied with the request, it is generated by the server and returned in the response.

Parameters

#/paths/~1v1~1tenants~1%7Btenant_id%7D~1realms~1%7Brealm_id%7D~1sso-configs/get/parameters/1 (unresolved $ref)

#/paths/~1v1~1tenants~1%7Btenant_id%7D~1realms~1%7Brealm_id%7D~1sso-configs/get/parameters/2 (unresolved $ref)

Request body

Example request

{
  "sso_config": {
    "payload": {
      "confidentiality": "confidential",
      "pkce": "s256"
    }
  }
}

Response

The sso config has been created.

idstring uuid required

A unique identifier for an SSO config. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the realm.

display_namestring required

A human-readable name for the SSO config. This name is used for display purposes.

Changes

Nov 6, 202642f3cac49392 Revision changes
- breaking
  removed subschema #5 subschema #6 from the / request property oneOf list
- breaking
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 to the response property oneOf list for the response status
- info
  added the new nametag_oauth2 enum value to the request property //////
- info
  added the new nametag_oauth2 enum value to the request property //////
- info
  added the new nametag_oauth2 enum value to the request property //////
- info
  added the new nametag_oauth2 enum value to the request property //////
- info
  added the new nametag_oauth2 enum value to the request property //////
- info
  added the new nametag_oauth2 enum value to the request property //////
- info
  added the new nametag_oauth2 enum value to the request property //////
- info
  added subschema #5 subschema #6 to the / request property oneOf list
- info
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 from the response property oneOf list for the response status

Operation history