Gets access overview

GET 
/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 [

userId integerrequired

The identifier for the user

Example: 3

createdAt date-timenullable

When the user was created

Example: 2023-03-01T12:04:26.061Z

userName stringnullable

The name of the user

Example: SomeUser

lastSeen date-timenullable

The last time the user logged in

Example: 2023-03-01T12:04:26.061Z

accessibleProjects string[]required

A list of project ids that this user has access to

Example: ["default","project2"]

groups string[]required

A list of group names that this user is a member of

Example: ["group1","group2"]

rootRole stringrequired

The name of the root role that this user has

Example: ADMIN

userEmail stringrequired

The email address of the user

Example: some-user@example.com

]

Example (from schema)

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

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

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

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

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ContentTypeerror
message string
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 (from schema)

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

Loading...