User Management

{
  "name": "John Smith",
  "email_address": "john.smith@example.gov.uk",
  "mobile_number": "+447700900123",
  "password": "SecurePassword123!",
  "auth_type": "sms_auth"
}

{
  "data": {
    "id": "user-uuid",
    "name": "John Smith",
    "email_address": "john.smith@example.gov.uk",
    "mobile_number": "+447700900123",
    "state": "pending",
    "auth_type": "sms_auth",
    "created_at": "2023-01-01T00:00:00Z"
  }
}

{
  "data": {
    "id": "user-uuid",
    "name": "John Smith",
    "email_address": "john.smith@example.gov.uk",
    "mobile_number": "+447700900123",
    "state": "active",
    "auth_type": "sms_auth",
    "email_access_validated_at": "2023-01-01T00:00:00Z",
    "logged_in_at": "2023-01-01T12:00:00Z",
    "failed_login_count": 0
  }
}

{
  "name": "John A. Smith",
  "email_address": "john.a.smith@example.gov.uk",
  "mobile_number": "+447700900456",
  "updated_by": "admin-user-uuid"
}

{
  "data": {
    "id": "user-uuid",
    "name": "John A. Smith",
    "email_address": "john.a.smith@example.gov.uk",
    "mobile_number": "+447700900456"
  }
}

{
  "data": {
    "id": "user-uuid",
    "state": "active"
  }
}

{
  "email": "john.smith@example.gov.uk"
}

{
  "data": {
    "id": "user-uuid",
    "name": "John Smith",
    "email_address": "john.smith@example.gov.uk",
    "mobile_number": "+447700900123",
    "state": "active"
  }
}

{
  "email": "john.smith"
}

{
  "data": [
    {
      "id": "user-uuid-1",
      "name": "John Smith",
      "email_address": "john.smith@example.gov.uk"
    },
    {
      "id": "user-uuid-2",
      "name": "John Smith Jr",
      "email_address": "john.smith.jr@example.gov.uk"
    }
  ]
}

{
  "password": "UserPassword123!"
}

{
  "result": "error",
  "message": {"password": ["Incorrect password"]}
}

{
  "to": "+447700900123"
}

{
  "email_auth_link_host": "https://notify.gov.uk",
  "next": "/services"
}

{
  "code": "123456",
  "code_type": "sms"
}

{
  "successful": true,
  "webauthn_credential_id": "credential-uuid"
}

{
  "data": {
    "id": "user-uuid",
    "failed_login_count": 0
  }
}

{
  "email": "john.smith@example.gov.uk",
  "admin_base_url": "https://notify.gov.uk",
  "next": "/services"
}

{
  "_password": "NewSecurePassword123!"
}

{
  "data": {
    "id": "user-uuid",
    "name": "John Smith"
  }
}

{
  "admin_base_url": "https://notify.gov.uk"
}

{
  "email": "new.email@example.gov.uk"
}

{
  "email": "existing@example.gov.uk"
}

{
  "permissions": [
    {"permission": "send_messages"},
    {"permission": "manage_templates"},
    {"permission": "manage_users"}
  ],
  "folder_permissions": ["folder-uuid-1", "folder-uuid-2"]
}

{
  "permissions": [
    {"permission": "manage_services"},
    {"permission": "view_all_services"}
  ]
}

{
  "organisations": [
    {
      "id": "org-uuid",
      "name": "Cabinet Office",
      "count_of_live_services": 5
    }
  ],
  "services": [
    {
      "id": "service-uuid",
      "name": "My Service",
      "restricted": false,
      "organisation": "org-uuid"
    }
  ]
}