Get project-role mappings

GET 
https://us.app.unleash-hosted.com/ushosted/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 stringrequired

Responses

200

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 stringrequired

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

Example: project-a

role integer

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

Example: 3

userCount integer

Number of users mapped to this project.

Example: 1

serviceAccountCount integer

Number of service accounts mapped to this project.

Example: 1

groupCount integer

Number of groups mapped to this project.

Example: 1

]

Example (from schema)

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

401

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
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: 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.

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."
}

403

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
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

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."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://us.app.unleash-hosted.com/ushosted/api/admin/projects/roles/:roleId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://us.app.unleash-hosted.com/ushosted

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

roleId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!