Skip to content
Shardkeep

Assign a role

POST
/role-assignments
curl --request POST \
  --url https://example.com/api/v1/role-assignments \
  --header 'Content-Type: application/json' \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session> \
  --data '{ "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "teamId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "kind": "GLOBAL", "teamId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "serverId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

Give a role to exactly one of a user or a team, at a global, team or server scope. Node permissions only take effect at global scope.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Set exactly one of userId and teamId.

object
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

Responses

Section titled “Responses”

201

Section titled “201”

Role assigned.

Media typeapplication/json
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
{
  "scope": {
    "kind": "GLOBAL"
  }
}

400

Section titled “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

Section titled “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

Section titled “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"
}

409

Section titled “409”

Clashes with existing data or state.

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

Shardkeep is free software under the AGPL-3.0. Minecraft is a trademark of Mojang AB; Shardkeep is not affiliated with or endorsed by Mojang or Microsoft.