コンテンツにスキップ
Authrim

Create a six-axis Scope Policy.

POST
/api/admin/agent-scope-policies
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/agent-scope-policies \
  --header 'Content-Type: application/json' \
  --cookie authrim_admin_session=<authrim_admin_session> \
  --data '{ "name": "example", "description": "example", "definition": { "tenantIds": [ "example" ], "environmentIds": [ "example" ], "domains": [ "example" ], "resourceIds": [ "example" ], "selectors": [ { "catalogId": "example", "version": 1, "value": "example" } ], "allowedFields": [ "example" ], "piiMode": "masked", "maxPerCall": 1, "maxPlanOperations": 1, "maxBulkTenants": 1 } }'

Requires a human Admin session. Arbitrary query, SQL, URL, and selector JSON are rejected.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
>= 1 characters <= 120 characters
description
string
<= 1000 characters
definition
required
object
tenantIds
required
Array<string>
>= 1 items <= 1000 items unique items
environmentIds
required
Array<string>
unique items
domains
required
Array<string>
unique items
resourceIds
required
Array<string>
unique items
selectors
required
Array<object>
object
catalogId
required
string
version
required
integer
>= 1
value
required
string
key
additional properties
allowedFields
required
Array<string>
unique items
piiMode
required
string
Allowed values: masked explicit_unmasked
maxPerCall
required
integer
>= 1 <= 100
maxPlanOperations
required
integer
>= 1 <= 100
maxBulkTenants
required
integer
>= 1 <= 1000
key
additional properties
key
additional properties

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Scope Policy version 1 created.

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