EPepilot
Roles

searchRoles

Changed on

Search Roles

post/v1/permissions/roles:search

Request

  • Base URL
    https://permissions.sls.epilot.io
  • URL
    https://permissions.sls.epilot.io/v1/permissions/roles:search
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Request body

role_idsRoleId[]

List of role ids to filter by

org_idsOrganizationId[]

List of organization ids to filter by

slugsSlug[]

List of role slugs to filter by

querystring

Input to search across fields

limitnumber

The Number of roles to return

offsetnumber

The number of roles to skip before starting to collect the result set

Example request

{
  "role_ids": [
    "123:manager",
    "456:owner"
  ],
  "org_ids": [
    "123",
    "456"
  ],
  "slugs": [
    "manager",
    "owner"
  ],
  "query": "Administrator",
  "limit": 1,
  "offset": 1
}

Response

ok

hitsnumber

Example response

{
  "results": [
    {
      "id": "123:owner",
      "name": "Owner",
      "slug": "owner",
      "expires_at": "2028-07-21T17:32:28Z",
      "organization_id": "123",
      "grants": [
        {
          "action": "entity-read",
          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",
          "conditions": [
            {
              "attribute": "workflows.primary.task_name",
              "values": [
                "Qualification"
              ]
            }
          ]
        }
      ],
      "parent_role": "123:owner"
    }
  ]
}

Changes

  • 546c43723a60Revision changes
    • info

      added the optional property /////// to the response with the status

  • b29ea9adf72bRevision changes
    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added to the ////////////// response property anyOf list for the response status

    • info

      added to the ////////////// response property anyOf list for the response status

    • info

      added to the ////////////// response property anyOf list for the response status

    • info

      added to the ////////////// response property anyOf list for the response status

    • info

      added to the ////////////// response property anyOf list for the response status