organization.updateMember

PATCH

/v1/organization/members/{userId}

const url = 'https://example.com/v1/organization/members/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"status":"active","roles":["super_administrator"],"policy":"example"}'
};

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

curl --request PATCH \
  --url https://example.com/v1/organization/members/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "active", "roles": [ "super_administrator" ], "policy": "example" }'

Changes the status, roles or extra policy of a member. A suspended member cannot sign in, and their tokens stop working.

Authorizations

token
session

Parameters

Path Parameters

userId

required

string

Request Body^required

application/json

object

status

string

Allowed values: active suspended

roles

Array

>= 1 items

policy

string

Responses

200

Success

application/json

object

userId

required

string

email

required

Any of:

string
null

string

name

required

Any of:

string
null

string

status

required

string

Allowed values: active suspended

roles

required

Array

>= 1 items

policy

required

string

joinedAt

required

string

Example

{
  "status": "active",
  "roles": [
    "super_administrator"
  ]
}

400

OrganizationRequired

application/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

MemberNotFound | RoleNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: MemberNotFound

userId

required

string

Example

{
  "_tag": "MemberNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | LastSuperAdministrator

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: OrganizationStorageUnavailable

Example

{
  "_tag": "OrganizationStorageUnavailable"
}

organization.updateMember

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

503

Example

Request Body^required