Apply a client profile preset.

POST

/api/admin/clients/{clientId}/apply-preset

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/clients/example/apply-preset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "preset": "spa" }'

Applies a named built-in profile preset to an existing client policy contract. The operation requires the client and tenant policy contract to exist and returns the saved profile, prior version, and validation warnings.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

clientId

required

string

Client identifier.

Request Body ^required

Media type application/json

object

preset

required

string

key

additional properties

Example

{
  "preset": "spa"
}

Responses

200

Client profile preset application response.

Media type application/json

object

profile

required

object

key

additional properties

appliedPreset

required

string

previousVersion

required

integer

warnings

required

Array<object>

object

key

additional properties

key

additional properties

Example ^generated

{
  "profile": {
    "additionalProperty": "example"
  },
  "appliedPreset": "example",
  "previousVersion": 1,
  "warnings": [
    {
      "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"
}

404

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"
}

412

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"
}

503

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"
}