コンテンツにスキップ
Authrim

Update JIT provisioning configuration

PUT
/api/admin/settings/jit-provisioning
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/jit-provisioning \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "default_role": "user", "allowed_domains": [ "example.com" ], "auto_link_by_email": true, "require_email_verified": true, "rate_limit": { "enabled": true, "max_attempts": 5, "window_seconds": 300 } }'

Merges the request into the existing SETTINGS KV JIT provisioning configuration after validation.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
key
additional properties
Example 
{
  "enabled": true,
  "default_role": "user",
  "allowed_domains": [
    "example.com"
  ],
  "auto_link_by_email": true,
  "require_email_verified": true,
  "rate_limit": {
    "enabled": true,
    "max_attempts": 5,
    "window_seconds": 300
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

JIT provisioning settings mutation result.

Media type application/json
object
config
object
enabled
boolean
allowedProviders
Array<string>
defaultRoles
Array<string>
requireEmailVerified
boolean
rate_limit

JIT provisioning rate limit settings.

object
key
additional properties
version
string
updated_at
integer
key
additional properties
source
string
defaults
object
enabled
boolean
allowedProviders
Array<string>
defaultRoles
Array<string>
requireEmailVerified
boolean
rate_limit

JIT provisioning rate limit settings.

object
key
additional properties
version
string
updated_at
integer
key
additional properties
message
string
key
additional properties
Example 
{
  "config": {
    "enabled": true,
    "default_role": "user",
    "allowed_domains": [
      "example.com"
    ],
    "auto_link_by_email": true,
    "require_email_verified": true,
    "rate_limit": {
      "enabled": true,
      "max_attempts": 5,
      "window_seconds": 300
    },
    "version": "1770000000000",
    "updated_at": 1770000000000
  },
  "message": "JIT Provisioning configuration updated"
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}