Identity status

Turns a user's sign-in on or off.

PUT /fieldservicegateway/usermanagement/v3/user/identity-status

Request

Field	Type	Required	Description
userNumber	number	yes	User to update. Must be 1 or greater
state	string	yes	active or inactive

Example

{
  "userNumber": 1001,
  "state": "inactive"
}

cURL

curl --request PUT 'https://[BASE_URL]/fieldservicegateway/usermanagement/v3/user/identity-status' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {{x-api-key}}' \
  --header 'Authorization: {{Authorization}}' \
  --header 'Asurion-correlationid: correlation-id' \
  --header 'Asurion-enduser: end-user' \
  --header 'Asurion-sourcesystem: source-system' \
  --header 'Asurion-serviceprovider: company-id' \
  --header 'Asurion-client: default' \
  --data '{
    "userNumber": 1001,
    "state": "inactive"
  }'

Response

200 OK

{
  "success": true,
  "message": "Identity status updated successfully",
  "data": {
    "state": "inactive"
  }
}

Errors

Status	Code	When
400	VALIDATION_ERROR	userNumber or state is missing or invalid
500	INTERNAL_ERROR	Something unexpected failed

{
  "success": false,
  "error": "Required field missing: state",
  "code": "VALIDATION_ERROR",
  "details": {
    "fields": [
      {
        "field": "state",
        "message": "This field is required",
        "code": "REQUIRED_FIELD"
      }
    ]
  },
  "correlationId": "correlation-id",
  "timestamp": "2026-10-16T00:00:00.000Z"
}