Solace DocsDeveloper HubSolace Community
API Reference

(Beta) Add or replace the claim mappings

put
https://api.solace.cloud/api/v2/platform/sso/idpClaimMappings

Add or replace the claim mappings.

Token Permissions: [ iam_claim_mapping:write ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

The claim key or name of the token issued by the identity provider (IdP).

claimValueToGroupsMapping
object
required

The claim mapping. A claim mapping is the value from the claim to the unique identifiers of the user groups.

boolean

Indicates whether to allow Just-In-Time (JIT). The valid values are 'true' (enable) or 'false' (disable). The default is 'false'.

uuid

The unique identifier of the user group to assign to a user when user's claim doesn't match any of the claims in the account (organization).

string
enum
required

The state of the claim mapping. The following states are:

  • enabled- Use the claim mapping. Users that log in using SSO are mapped to specified roles.
  • disabled- To not use the claim mapping. Users that log in using SSO are not mapped to the specified roles.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 12 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 12 months ago