Skip to main content
POST
/
api
/
v1
/
bko
/
members
/
{membershipId}
/
revoke
Revoke Member
curl --request POST \
  --url https://api.example.com/api/v1/bko/members/{membershipId}/revoke
{
  "membershipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "googleProviderId": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phoneIso": "<string>",
    "phoneDdi": "<string>",
    "phoneNumber": "<string>",
    "phoneVerified": true,
    "emailVerified": true,
    "avatar": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": {
    "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "revokedAt": "2023-11-07T05:31:56Z",
  "revokedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
membershipId
string<uuid>
required

Membership identifier

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Membro interno da BKO baseado em uma Membership INTERNAL.

​
membershipId
string<uuid>
required
​
userId
string<uuid>
required
​
user
object
required

Identidade global do sistema — credenciais e dados de acesso. A senha nunca é retornada pela API.

​
organizationId
string<uuid> | null
required
​
roleId
string<uuid>
required
​
role
object
required

Papéis de acesso internos, de ambiente ou customizados por organização

​
status
enum<string>
required
Available options:
ACTIVE,
REVOKED
​
revokedAt
string<date-time> | null
required
​
revokedBy
string<uuid> | null
required
​
createdBy
string<uuid> | null
required
​
createdAt
string<date-time>
required
​
updatedBy
string<uuid> | null
required
​
updatedAt
string<date-time>
required