Create an OIDC scope.

POST

/api/admin/field-mapping/oidc-scopes

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/oidc-scopes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "display_name": "example", "description": "example", "scope_type": "custom", "enabled": true, "localizations": { "additionalProperty": "example" } }'

Creates a tenant-scoped custom OIDC scope for use from the field-mapping editor.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

name

required

string

/^[A-Za-z0-9][A-Za-z0-9:._~-]{0,127}$/

display_name

required

string

description

string | null

scope_type

string

default: custom

Allowed values: custom

enabled

boolean

default: true

localizations

object

key

additional properties

Responses

201

Created OIDC scope.

Media type application/json

object

scope

object

key

additional properties

Example ^generated

{
  "scope": {
    "additionalProperty": "example"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}