Deactivate a mPass user

POST 
/api/gateway/v1/mpass/users/:userId/deactivate

Deactivate a mPass user

Request

Path Parameters

userId stringrequired

User ID

Header Parameters

x-api-key stringrequired

Gateway API key

Responses

200

User deactivated successfully

application/json

Schema

Schema

status numberrequired

Response status code

message stringrequired

Response status message

data

object

required

Response data

userId stringrequired

User ID

status stringrequired

User status

requestId string

Request ID for tracking

Example (from schema)

{
  "status": 200,
  "message": "OK",
  "data": {
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "deactivated"
  },
  "requestId": "req-123456"
}

401

Unauthorized

application/json

Schema

Schema

status number
message string

error

object

code string

Error code

detail string

Error detail

Example (from schema)

{
  "status": 401,
  "message": "Invalid API key",
  "error": {
    "code": "UNAUTHORIZED",
    "detail": "Invalid API key"
  }
}

404

User not found

Loading...