List users

GET

/api/security/users

const url = 'https://example.com/api/security/users';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/security/users \
  --header 'Authorization: Bearer <token>'

Retrieves all users in the system

Authorizations

bearerAuth

Responses

200

Users retrieved successfully

application/json

object

count

Total number of users

number

items

required

Array of users

Array<object>

object

required

User ID (typically email)

string

searchId

required

Searchable ID

string

name

required

Display name

string

repos

Repository permissions

Array<object>

default:

object

CACHE_ROOT

required

Repository namespace

string

required

Repository ID

string

permission

required

Permission level (view, write, admin)

string

roles

Assigned roles

Array<string>

default:

groups

Group memberships

Array<string>

default:

type

Entity type

string

default: user

description

User description

string

preferences

User preferences

object

view

required

object

defaultView

required

Default view mode

string

Allowed values: grid list

tableColumns

Saved table column selections

Array<string>

recentRepositories

Recently visited repositories

Array<object>

<= 3 items

object

CACHE_ROOT

required

Repository namespace

string

name

Display name

string

lastVisited

required

Timestamp of last visit

number

recentSites

Recently visited sites

Array<object>

<= 3 items

object

required

Site ID

string

name

Site name

string

lastVisited

required

Timestamp of last visit

number

detailPaneColumns

Number of grid columns visible when detail pane is open

number

default: 2 >= 1 <= 5

theme

UI theme mode

string

default: dark

Allowed values: dark light

uiVersion

UI version preference

string

default: content2

Allowed values: content content2

Example

{
  "items": [
    {
      "id": "user@example.com",
      "searchId": "user@example.com",
      "name": "John Doe",
      "repos": [],
      "roles": [],
      "groups": [],
      "type": "user",
      "description": "",
      "preferences": {
        "view": {
          "defaultView": "grid"
        }
      }
    }
  ]
}