Update User Activation Status

PATCH 
/users/activation

Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password.

Request

*/*

Body

user_id string
is_active boolean

Responses

200

Created

application/json

Schema

Schema

id stringrequired
first_name stringrequired
last_name stringrequired
email stringrequired
roles string[]required
is_active booleanrequired

Example (from schema)

[
  {
    "id": "7a4c6555-1f73-49b3-a211-f95bd2b8ec90",
    "first_name": "John",
    "last_name": "Doe",
    "email": "email@email.com",
    "roles": [
      "developer"
    ],
    "is_active": true
  },
  {
    "id": "5f4df1dd-c84f-482a-84ad-541ffd46e75a",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "email@email.com",
    "roles": [
      "financial_controller"
    ],
    "is_active": false
  }
]

Example

{
  "message": "user activation was updated successfully"
}

401

Unauthorized

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

Loading...