Versions Compared

Old Version 4

changes.mady.by.user Rohit Sinha

Saved on

compared with

New Version 5

changes.mady.by.user Rohit Sinha

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
OperationREST APIBodyResponseCLI Command (from Security CLI commands)
grantsecurity/authorization/grant
Code Block
titleGrantRequest
{
  "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 <entity-id> principal-type <principal-type-name> principal-name <principal-name> actions READ
revokesecurity/authorization/revoke
Code Block
titleRevokeRequest
{
  "entity": {
    "namespace": "ns1",
    "entity": "NAMESPACE"
  },
  "principal": {
    "name": "admin",
    "type": "ROLE"
  },
  "actions": [
    "READ"
  ]
}

200: Revoked the actions on the entity for the principal

security revoke entity <entity-id> principal-type <principal-type-name> principal-name <principal-name> actions READ
check authorizedsecurity/authorization/authorized
Code Block
titleCheckAuthorizedRequest
{
  "entity": {
    "namespace": "ns1",
    "entity": "NAMESPACE"
  },
  "principal": {
    "name": "admin",
    "type": "ROLE"
  },
  "actions": [
    "READ"
  ]
}

200: authorized

401403: Unauthorized

security access entity <entity-id> principal-type <principal-type> principal-name <principal-name> action READ
Role Based Access Control
create role

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

N/A

200: Created the role

409: role already exists

 
security create role <role-name>
delete roleDELETE /security/authorization/roles/<role-name>N/A

200: Deleted the role

404: role is not found

 
 
security drop role <role-name>
List rolesGET /security/authorization/roles/N/A

200: List of roles

Code Block
titleRoles
["Role", "Role2"]
 
security list roles
add role to principalPUT /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 principalDELETE /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 principalGET /security/authorization/<principal-type>/<principal-name>/roles

N/A

 200: List of roles

Code Block
titleRoles
["Role", "Role2"]

404: Principal not found

 
security list roles for group/user <group/user-name>
 List privileges for roleGET /security/authorization/roles/<role-name>/privilegesN/A 

 200: List of privileges for the role

Code Block
titlePrivileges
["Privilege1", "Privilege2"]

404: role not found

 
security list privileges for role <role-name>