コンテンツにスキップ
Authrim

Update admin policy

PATCH
/api/admin/admin-policies/{id}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/admin-policies/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "Allow support users to read and export user records.", "actions": [ "read", "export" ], "enabled": true }'

Updates mutable fields of a tenant admin access policy using explicit field mapping.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”

JSON request body.

Media type application/json
object
>= 1 properties
name
string
description
string
priority
integer
effect
string
Allowed values: allow deny
resource_types
Array<string>
actions
Array<string>
conditions
Array<object>
object
type
string
params
object
key
additional properties
key
additional properties
enabled
boolean
key
additional properties
Example 
{
  "description": "Allow support users to read and export user records.",
  "actions": [
    "read",
    "export"
  ],
  "enabled": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Admin policy response.

Media type application/json
object
id
required
string
name
required
string
description
string
priority
required
integer
effect
required
string
Allowed values: allow deny
conditions
required
Array<object>
object
type
string
params
object
key
additional properties
key
additional properties
resource_types
required
Array<string>
actions
required
Array<string>
enabled
required
boolean
created_by
required
string | null
created_at
required
integer format: int64
updated_by
required
string | null
updated_at
required
integer format: int64
key
additional properties
Example 
{
  "id": "policy_123",
  "tenant_id": "tenant_123",
  "name": "allow_support_users",
  "display_name": "Allow support users",
  "effect": "allow",
  "priority": 100,
  "resource_pattern": "/admin/support/*",
  "actions": [
    "read"
  ],
  "conditions": {
    "condition_type": "all"
  },
  "is_active": true,
  "is_system": false,
  "created_at": 1770000000000,
  "updated_at": 1770000000000
}

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

404

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

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