organization.removeMember

DELETE

/v1/organization/members/{userId}

const url = 'https://example.com/v1/organization/members/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/organization/members/example \
  --header 'Authorization: Bearer <token>'

Removes a member and revokes their tokens. If their email domain is still allowed, they join again the next time they sign in. Suspend them to keep them out.

Authorizations

token
session

Parameters

Path Parameters

userId

required

string

Responses

204

400

PolicyInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: PolicyInvalid

message

required

string

Example

{
  "_tag": "PolicyInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

PermissionDenied | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read

resource

required

string

Example

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

MemberNotFound

application/json

object

_tag

required

string

Allowed values: MemberNotFound

userId

required

string

Example

{
  "_tag": "MemberNotFound"
}

409

LastSuperAdministrator

application/json

object

_tag

required

string

Allowed values: LastSuperAdministrator

Example

{
  "_tag": "LastSuperAdministrator"
}

503

OrganizationStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

application/json

Any of:

object

_tag

required

string

Allowed values: OrganizationStorageUnavailable

Example

{
  "_tag": "OrganizationStorageUnavailable"
}