Remove user from organization

DELETE

/api/v1/organizations/{organizationId}/members/{userId}

const url = 'https://localhost:8080/api/v1/organizations/example/members/example';
const options = {method: 'DELETE', headers: {Authorization: '<Authorization>'}};

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://localhost:8080/api/v1/organizations/example/members/example \
  --header 'Authorization: <Authorization>'

Remove a user from an organization and best-effort remove them from the bound IDP organization

Authorizations

BearerAuth
ApiKeyAuth

Parameters

Path Parameters

organizationId

required

string

Organization ID or UUID (bare or urn:uuid)

userId

required

string

User UUID (bare or urn:uuid) or did:key

Responses

200

User removed successfully

application/json

Confirmation that a user was removed from an organization, naming who was removed

object

message

string

organizationId

integer

userId

string

Example

{
  "message": "User removed from organization successfully",
  "organizationId": 123,
  "userId": "550e8400-e29b-41d4-a716-446655440000"
}

400

Invalid request

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - requires Organization Owner role

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404

Organization, user, or membership not found

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}