Skip to main content
POST
Create a mapper

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.