Block User

Membership.

A contact (user) is a person in your project's membership directory, with one or more linked logins (identities). Membership manages their profile, identities, roles, and lifecycle.

Blocks the user.

This action is destructive or irreversible. Make sure you target the right item and confirm before running it.

Membership

patch

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

VersionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

Membership

correlationIdstringOptional

CorrelationId for each request

cultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstringOptional

TimeZone

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

envstringOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

databaseIntegrationIdstring · nullableOptional

Database integration id. Optional — defaults to the request environment's default integration.

idstring · nullableRequired

Id of the user to block, from get_users.

Responses

200

Success

application/json

EmptyResponse

patch/{version}/membership/auth/block

PATCH /{version}/membership/auth/block HTTP/1.1
Host: api.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 157

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "databaseIntegrationId": "text",
  "id": "text",
  "version": "text"
}

200

Success

{
  "success": {
    "responseStatus": {
      "isSuccess": true
    }
  },
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Membership → Users.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Block User in the SDK reference, with examples in every language.