platform.removePlatformAdmin

DELETE

/v1/platform/admins/{email}

const url = 'https://example.com/v1/platform/admins/example';
const options = {method: 'DELETE', 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 DELETE \
  --url https://example.com/v1/platform/admins/example \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Path Parameters

email

required

string

Responses

204

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

PlatformAdminNotFound

application/json

object

_tag

required

string

Allowed values: PlatformAdminNotFound

email

required

string

Example

{
  "_tag": "PlatformAdminNotFound"
}

409

LastPlatformAdmin | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: LastPlatformAdmin

Example

{
  "_tag": "LastPlatformAdmin"
}

503

PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PlatformUnavailable

Example

{
  "_tag": "PlatformUnavailable"
}