v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Resource Roles

Get Resource Role Descendants

get/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/descendants

Path parameters

resource_idstring required

Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug").

Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug").

role_idstring required

Either the unique id of the role, or the URL-friendly key of the role (i.e: the "slug").

Either the unique id of the role, or the URL-friendly key of the role (i.e: the "slug").

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Response

Successful Response

Example response

{
  "roles": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "key": "maintainer",
      "name": "Maintainer",
      "description": "the maintainer role can read from the repo and push changes",
      "permissions": [
        "push"
      ],
      "extends": [
        "contributor"
      ],
      "resource": "repo",
      "granted_to": {
        "id": "8c0a5d99-de8d-4102-b363-7d17843156b3",
        "users_with_role": [
          {
            "role": "Admin",
            "on_resource": "organization",
            "linked_by_relation": "owner",
            "role_id": "4f9ad7ab-15bc-4e25-a5a5-57417b341719",
            "resource_id": "17dbf1da-4061-44a6-8f58-55719560f143",
            "relation_id": "534b2d8a-e8be-4039-828f-0607691ca48c"
          }
        ]
      },
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
      "resource_id": "40ef0e48-a11f-4963-a229-e396c9f7e7dd",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}