Gets access overview

GET 
<your-unleash-url>/api/admin/access/overview

Gets an overview of what access all users have to all projects and groups

Responses

200

accessOverviewSchema

application/json

Schema

Schema

overview object[]
A list of user access details
Array [
userIdintegerrequired
The identifier for the user
Example: 3
createdAtdate-timenullable
When the user was created
Example: 2023-03-01T12:04:26.061Z
userNamestringnullable
The name of the user
Example: SomeUser
lastSeendate-timenullable
The last time the user logged in
Example: 2023-03-01T12:04:26.061Z
accessibleProjectsstring[]required
A list of project ids that this user has access to
Example: ["default","project2"]
groupsstring[]required
A list of group names that this user is a member of
Example: ["group1","group2"]
rootRolestringrequired
The name of the root role that this user has
Example: ADMIN
userEmailstringrequired
The email address of the user
Example: some-user@example.com
]

Example (auto)

{
  "overview": [
    {
      "userId": 3,
      "createdAt": "2023-03-01T12:04:26.061Z",
      "userName": "SomeUser",
      "lastSeen": "2023-03-01T12:04:26.061Z",
      "accessibleProjects": [
        "default",
        "project2"
      ],
      "groups": [
        "group1",
        "group2"
      ],
      "rootRole": "ADMIN",
      "userEmail": "some-user@example.com"
    }
  ]
}

text/csv

Schema

Schema

stringstring

Example (auto)

"string"

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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
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 (auto)

{
  "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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

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

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ContentTypeerror
messagestring
A description of what went wrong.
Example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

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 '<your-unleash-url>/api/admin/access/overview' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

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