Skip to main content
GET
/
api
/
access-control
/
principals
Search principals
curl --request GET \
  --url https://api.rigbox.dev/api/access-control/principals \
  --header 'Authorization: Bearer <token>'
{
  "principals": [
    {
      "email": "<string>",
      "principal": "<string>",
      "user_id": "<string>",
      "display_name": "<string>"
    }
  ]
}
Use this to look up principals by email or name before creating role bindings.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
resource
string
required

Canonical resource ref, e.g. rig:workspace:ws-123

​
query
string
required

Email or display-name search text

​
limit
integer

Optional result limit (max 20)

Required range: x >= 0

Response

Assignable principal search results

​
principals
object[]
required