Create mapping rule

POST 
/mapping-rules

Create a new mapping rule

Request

application/json

Body

claimName stringrequired

The name of the claim to map.

claimValue stringrequired

The value of the claim to map.

name stringrequired

The name of the mapping.

Responses

201

The mapping rule was created successfully.

application/json

Schema

Schema

claimName string

The name of the claim to map.

claimValue string

The value of the claim to map.

name string

The name of the mapping.

mappingKey string

The key of the created mapping rule.

Example (from schema)

{
  "mappingKey": "string",
  "claimName": "string",
  "claimValue": "string",
  "name": "string"
}

application/vnd.camunda.api.keys.number+json

Schema

Schema

claimName string

The name of the claim to map.

claimValue string

The value of the claim to map.

name string

The name of the mapping.

mappingKey int64

The key of the created mapping rule.

Example (from schema)

{
  "mappingKey": 0,
  "claimName": "string",
  "claimValue": "string",
  "name": "string"
}

application/vnd.camunda.api.keys.string+json

Schema

Schema

claimName string

The name of the claim to map.

claimValue string

The value of the claim to map.

name string

The name of the mapping.

mappingKey string

The key of the created mapping rule.

Example (from schema)

{
  "mappingKey": "string",
  "claimName": "string",
  "claimValue": "string",
  "name": "string"
}

400

The mapping rule could not be created.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

The request to create a mapping rule was denied. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

The request to create a mapping rule was denied.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...