Add Custom Permission (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/permissions

Add a custom permission.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Permission details

allowed_after_ms int64

Allowed After Ms

allowed_before_ms int64

Allowed Before Ms

disabled boolean

List the disabled custom permissions.

disabled_reason string

The reason for disabling the custom permission.

disallow_permission boolean

Disallow Permission

id string

The ID.

inactive boolean

List the inactive custom permissions.

inactive_reason string

The reason for the custom permission being inactive.

region string

The region.

tenant_id stringrequired

ID of the tenant.

value stringrequired

The custom permission value.

Responses

200

Successful Operation

application/json

Schema

Schema

allowed_after_ms int64

Allowed After Ms

allowed_before_ms int64

Allowed Before Ms

disabled boolean

List the disabled custom permissions.

disabled_reason string

The reason for disabling the custom permission.

disallow_permission boolean

Disallow Permission

id string

The ID.

inactive boolean

List the inactive custom permissions.

inactive_reason string

The reason for the custom permission being inactive.

region string

The region.

tenant_id stringrequired

ID of the tenant.

value stringrequired

The custom permission value.

Example (from schema)

{
  "allowed_after_ms": 0,
  "allowed_before_ms": 0,
  "disabled": true,
  "disabled_reason": "string",
  "disallow_permission": true,
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "region": "string",
  "tenant_id": "string",
  "value": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "ESP_INVALID_TENANT_ID"
      },
      {
        "code": "PERMISSION_API_TEST_FAILED"
      },
      {
        "code": "PERMISSION_NOT_CUSTOMIZED"
      },
      {
        "code": "PERMISSION_AFTER_LARGER_THAN_BEFORE"
      },
      {
        "code": "PERMISSION_TENANT_ID_MISMATCH"
      },
      {
        "code": "PERMISSION_API_TEST_TENANTID_FAILED"
      }
    ]
  }
}

Loading...