Offboarding

Disable a customer user

Disables a customer user by their userId (reversible operation). Customer must be in a company within the actor's regulated entity.

Required entitlement: regulated.customers.canDisableCustomer
Entitles the regulated user to disable (suspend) customer users within their regulated entity

post/api-regulated/v1/users/{userId}/disable-customer

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/users/{userId}/disable-customer
  • Auth: OAuth 2 (implicit, authorization URL https://auth.currencyguard.com/oauth2/authorize, scopes: regulated.customers.canDisableCustomer)

Path parameters

userIdstring uuid required

The target user's ID

Response

User disabled successfully

idstring uuid

The ID for this user.

subClaimstring

The unique identifier from JWT sub claim for this user.

roleClaimsstring

The role claims for this user as a concatenated string.

status'PENDING' | 'ENABLED' | 'DISABLED' | 'DELETED'

The status of this user account.

onboardedDatestring

The date when the user was onboarded.

entitlementsTemplateIdstring uuid

The entitlements template assigned to this user.

piiDataUserDTOPiiData

Extensible JSONB field - The PII data for this user as encrypted JSON. This field accepts any valid JSON structure and can be extended with additional properties as needed. Note: While the structure is extensible, known fields shown in the example are subject to application validation.

preferencesUserDTOPreferences

Extensible JSONB field - UI preferences for this user, namespaced by section. This field accepts any valid JSON structure and can be extended with additional properties as needed. Note: While the structure is extensible, known fields shown in the example are subject to application validation.

perimeterIdstring uuid

The tenant perimeter whose KMS key encrypts this user's PII.

authTypestring

The authentication type for this user. OAUTH2_AUTHORIZATION_CODE for interactive human users, OAUTH2_CLIENT_CREDENTIALS for machine-to-machine API clients.

eventSequenceinteger

Event sequence number for event sourcing.

versionNumberinteger

The strictly monotonically increasing version number for this record.

updatedBystring

The username of the person or entity that updated this record.

updatedAtstring

The timestamp of the last update in UTC.

createdAtstring

The timestamp of creation in UTC.

Example response

{
  "id": "12345678-1234-4001-8000-123456789012",
  "subClaim": "auth0|12345678-1234-4001-8000-123456789012",
  "roleClaims": "ROLE_ADMIN,ROLE_TRADER",
  "status": "ENABLED",
  "onboardedDate": "2024-01-15T00:00:00Z",
  "entitlementsTemplateId": "12345678-1234-4001-8000-123456789012",
  "piiData": {
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+44 20 7946 0958",
    "jobTitle": "Risk Manager",
    "department": "Trading"
  },
  "preferences": {
    "tables": {
      "guard-book": {
        "pageSize": 50
      }
    }
  },
  "perimeterId": "cccccccc-cc11-4001-8000-000000000000",
  "authType": "OAUTH2_AUTHORIZATION_CODE",
  "eventSequence": 12345,
  "versionNumber": 1,
  "updatedBy": "jbloggs24",
  "updatedAt": "2024-10-18T12:30:40Z",
  "createdAt": "2024-10-18T12:30:40Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.