Skip to main content
POST
/
api
/
identity-providers
/
{alias}
/
mappers
Create a mapper
curl --request POST \
  --url https://api.example.com/api/identity-providers/{alias}/mappers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "identity_provider_mapper": "<string>",
  "id": "<string>",
  "config": {}
}
'
{
  "name": "<string>",
  "identity_provider_mapper": "<string>",
  "id": "<string>",
  "config": {}
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
alias
string
required

Body

application/json

A single IdP mapper for claim or attribute mapping.

​
name
string
required

Mapper name. For example, email-mapper.

​
identity_provider_mapper
string
required

Mapper type. For example, oidc-user-attribute-idp-mapper or saml-user-attribute-idp-mapper.

​
id
string | null

Mapper ID. It's set by Keycloak and omits on create.

​
config
Config · object

Mapper config. It's keys vary by mapper types, such as syncMode, claim, or user.attribute.

Response

Mapper created.

A single IdP mapper for claim or attribute mapping.

​
name
string
required

Mapper name. For example, email-mapper.

​
identity_provider_mapper
string
required

Mapper type. For example, oidc-user-attribute-idp-mapper or saml-user-attribute-idp-mapper.

​
id
string | null

Mapper ID. It's set by Keycloak and omits on create.

​
config
Config · object

Mapper config. It's keys vary by mapper types, such as syncMode, claim, or user.attribute.