Page Comparison

Operation

REST API

Body

Response

CLI Command (from Security CLI commands)

grant

security/authorization/grant

Code Block

title	GrantRequest

{
  "entity": {
    "namespace": "ns1",
    "entity": "NAMESPACE"
  },
  "principal": {
    "name": "admin",
    "type": "ROLE"
  },
  "actions": [
    "READ"
  ]
}

200: Granted the action on the entity for the principal

security grant entity NAMESPACE:default principal-type ROLE principal-name admins actions READ

revoke

security/authorization/revoke

Code Block

title	RevokeRequest

{
  "entity": {
    "namespace": "ns1",
    "entity": "NAMESPACE"
  },
  "principal": {
    "name": "admin",
    "type": "ROLE"
  },
  "actions": [
    "READ"
  ]
}

200: Revoked the actions on the entity for the principal

check authorized

security/authorization/authorized

Code Block

title	CheckAuthorizedRequest

{
  "entity": {
    "namespace": "ns1",
    "entity": "NAMESPACE"
  },
  "principal": {
    "name": "admin",
    "type": "ROLE"
  },
  "actions": [
    "READ"
  ]
}

200: authorized

401: Unauthorized

create role

PUT /security/authorization/roles/<role-name>

N/A

200: Created the role

409: role already exists

security create role <role-name>

delete role

DELETE /security/authorization/roles/<role-name>

N/A

200: Deleted the role

404: role is not found

security drop role <role-name>

List roles

GET /security/authorization/roles/

N/A

200: List of roles

Code Block

title	Roles

["Role", "Role2"]

security list roles

add role to principal

PUT /security/authorization/<principal-type>/<principal-name>/roles/<role-name>

200: Added role to principal

404: role not found

404: principal not found

security add role <role-name> to group/user <group/user-name>

remove role from principal

DELETE /security/authorization/<principal-type>/<principal-name>/roles/<role-name>

200: removed role from principal

404: role not found

404: principal not found

security remove role <role-name> from group/user <group/user-name>

List roles for principal

GET /security/authorization/<principal-type>/<principal-name>/roles

N/A

200: List of roles

Code Block

title	Roles

["Role", "Role2"]

404: Principal not found

security list roles for group/user <group/user-name>

List privileges for role

GET /security/authorization/roles/<role-name>/privileges

N/A

200: List of privileges for the role

Code Block

title	Privileges

["Privilege1", "Privilege2"]

404: role not found

security list privileges for role <role-name>

Versions Compared

Old Version 2

New Version 3

Key