Revoke Privilege

POST

/api/v1/permissions/revoke

curl --request POST \
  --url https://example.com/api/v1/permissions/revoke \
  --header 'Content-Type: application/json' \
  --data '{ "privilege": "example", "object_type": "example", "object_name": "example", "grantee_name": "example", "grantee_type": "example" }'

Revoke a privilege on an object from a user/role.

Args: request: Revoke request details

Returns: PermissionOperationResponse with operation result

Raises: HTTPException: If revoke operation fails

Parameters

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

RevokeRequest

Request to revoke a privilege.

object

privilege

required

Privilege

Privilege to revoke

string

object_type

required

Object Type

Object type

string

object_name

required

Object Name

Object name

string

grantee_name

required

Grantee Name

User/role to revoke from

string

grantee_type

required

Grantee Type

Grantee type (USER or ROLE)

string

/^(USER|ROLE)$/

Example^generated

{
  "privilege": "example",
  "object_type": "example",
  "object_name": "example",
  "grantee_name": "example",
  "grantee_type": "example"
}

Responses

200

Successful Response

Media typeapplication/json

PermissionOperationResponse

Response for permission operations.

object

success

required

Success

Whether the operation was successful

boolean

message

required

Message

Operation result message

string

details

Any of:

object

object

key

additional properties

any

null

null

Example^generated

{
  "success": true,
  "message": "example",
  "details": {}
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}