/role-store/api/v1/roles/evaluate

post

https://example.com/role-store/api/v1/roles/evaluate

Evaluate a new role definition. Returns an array of matching users for the role mapping. If too many hits, only count field is populated and users array is left empty.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

uuid

The UUID of the returned object

name

string

required

Name of the role

comment

string

A comment describing the object

principal_public_key_strings

array of strings

principal_public_key_strings

permit_agent

boolean

Permit agent

access_group_id

uuid

Scopes host and connection permissions to an access group

permissions

array of strings

Array of permissions

permissions

context

object

Contextual limitation

type

string

role type

arn

string

role ARN

system

boolean

Defaults to false

Is the role PrivX internal

created

date-time

When the object was created

author

uuid

ID of the user who originally authored the object

updated

date-time

When the object was created

updated_by

uuid

ID of the user who updated the object

deleted

date-time

When the object was deleted (tombstoned)

deleted_by

uuid

ID of the user who deleted the object

source_rules

object

required

A source rule(s) definition. Can be a single rule or a rule group, in which case either "single" or "group" attributes are requrired

200Response for role mapping evaluation

400Bad request

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error