List role assignments

GET

/role-assignments

curl --request GET \
  --url https://example.com/api/v1/role-assignments \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Authorizations

• sessionCookie
• bearerToken

Parameters

Query Parameters

userId

string format: uuid

teamId

string format: uuid

roleId

string format: uuid

Responses

200

Assignments, oldest first.

Media typeapplication/json

object

items

required

Array<object>

object

id

required

string format: uuid

roleId

required

string format: uuid

userId

string format: uuid

teamId

string format: uuid

scope

required

Where an assignment applies. GLOBAL covers everything; TEAM covers the servers the team owns (set teamId); SERVER covers one server (set serverId).

object

kind

required

string

Allowed values: GLOBAL TEAM SERVER

teamId

string format: uuid

serverId

string format: uuid

createdAt

required

string format: date-time

Example

{
  "items": [
    {
      "scope": {
        "kind": "GLOBAL"
      }
    }
  ]
}

400

The request is invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

403

Signed in, but not allowed.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}