Get project-role mappings

GET /api/admin/projects/roles/:roleId/access

For the provided role, retrieves a list of projects that use this role. For each project it also contains information about how the role used in that project, such as how many users, groups, or service accounts that use the role.

Request

Path Parameters

• roleId string required

Responses

• 200
• 401
• 403

---

projectRoleUsageSchema

application/json

Schema

Schema

• projects object[]

  A collection of projects with counts of users and groups mapped to them with specified roles.

  Array [

  project string required

  The id of the project user and group count are counted for.

  role integer

  Id of the role the user and group count are counted for.

  userCount integer

  Number of users mapped to this project.

  serviceAccountCount integer

  Number of service accounts mapped to this project.

  groupCount integer

  Number of groups mapped to this project.

  ]

Example (from schema)

{
  "projects": [
    {
      "project": "project-a",
      "role": 3,
      "userCount": 1,
      "serviceAccountCount": 1,
      "groupCount": 1
    }
  ]
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Loading...