Skip to content
Nexa Platform Docs

Grant Role

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

Grant a role to a user/role.

Args: request: Role grant request details

Returns: PermissionOperationResponse with operation result

Raises: HTTPException: If role grant fails

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
RoleGrantRequest

Request to grant a role to a user/role.

object
role_name
required
Role Name

Role to grant

string
grantee_name
required
Grantee Name

User/role to grant role to

string
grantee_type
required
Grantee Type

Grantee type (USER or ROLE)

string
/^(USER|ROLE)$/
Examplegenerated
{
  "role_name": "example",
  "grantee_name": "example",
  "grantee_type": "example"
}

Responses

Section titled “Responses”

200

Section titled “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
key
additional properties
any
Examplegenerated
{
  "success": true,
  "message": "example",
  "details": {}
}

422

Section titled “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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}