Create a user

POST

/api/security/users/{id}

const url = 'https://example.com/api/security/users/example';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","description":"example","roles":["example"],"groups":["example"],"repos":[{"CACHE_ROOT":"my-repo","id":"repo-123","permission":"write"}]}'
};

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

curl --request POST \
  --url https://example.com/api/security/users/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "roles": [ "example" ], "groups": [ "example" ], "repos": [ { "CACHE_ROOT": "my-repo", "id": "repo-123", "permission": "write" } ] }'

Creates a new user with the specified ID

Authorizations

bearerAuth

Parameters

Path Parameters

required

User ID (email)

string

Request Body

application/json

object

name

Display name

string

description

Description

string

roles

Role assignments

Array<string>

groups

Group memberships

Array<string>

repos

Repository permissions

Array<object>

object

CACHE_ROOT

required

Repository namespace

string

Example

my-repo

required

Repository ID

string

Example

repo-123

permission

required

Permission level (view, write, admin)

string

Example

write

Responses

200

User created successfully

application/json

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

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

400

Invalid request