tocdepth: 2

Просмотр и изменение параметров пользователей

Через API можно просмотреть и отредактировать параметры пользователя, даже если он еще не принял приглашение и не добавлен в организацию.

Просмотр федеративного пользователя

Можно посмотреть параметры пользователя, выполнив поиск нужной записи по ID или email.

Найти пользователя по ID

Чтобы найти пользователя организации по идентификатору и посмотреть его параметры, выполните запрос:

curl --location 'https://iam.api.cloud.ru/api/v1/customers/<customerId>/users/<userId>' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer <аутентификационный токен>'

Где:

customerId — идентификатор организации;
userId — идентификатор пользователя.

Пример ответа

{
  "user": {
      "user_id": "exxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
      "username": "ivanovivan@gmail.com",
      "email": "ivanovivan@gmail.com",
      "account_type": "USER_ACCOUNT_TYPE_LOCAL"
  }
}

Найти пользователя по email

Выполните запрос:

curl --location 'https://iam.api.cloud.ru/api/v1/customers/<customerId>/users/find?email=<ivanovivan@gmail.com>&type=USER_ACCOUNT_TYPE_UNDEFINED' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer ey***A'

Где:

customerId — Идентификатор организации.
email — Электронная почта пользователя.
type — Тип пользователя:
- USER_ACCOUNT_TYPE_LOCAL — Будут найдены только локальные пользователи.
- USER_ACCOUNT_TYPE_FEDERATED — Будут найдены только федеративные пользователи.
- USER_ACCOUNT_TYPE_UNDEFINED — Будут найдены и локальные, и федеративные пользователи.

Пример ответа

{
  "user": {
      "user_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
      "username": "ivanovivan@gmail.com",
      "email": "ivanovivan@gmail.com",
      "first_name": "Иван",
      "last_name": "Иванов",
      "middle_name": "Иванович",
      "enabled": true,
      "account_type": "USER_ACCOUNT_TYPE_FEDERATED"
  }
}

Коды ошибок

404 Not Found

Задан не тот параметр в type.

Решение:
{
  "code": 5,
  "message": "user not found by email and namespace_id",
  "details": []
}
400 Bad Request

В запросе не задан email.

Решение:
{
  "code": 3,
  "message": "duplicated users found by email and namespace_id: specify account type to narrow down search",
  "details": []
}
400 Bad Request

В запросе поиска заданы одновременно и email, и ID.

Решение:
{
  "code": 3,
  "message": "duplicated users found by email and namespace_id: specify account type to narrow down search",
  "details": []
}

Изменить параметры федеративного пользователя

Чтобы изменить параметры, выполните запрос:

curl --location --request PUT 'https://iam.api.cloud.ru/api/v1/customers/<customersId>/users/<userId>' \
     --header 'accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <аутентификационный токен>' \
     --data '{
       "firstName": "Ольга",
       "lastName": "Иванова",
       "middleName": "Ивановна",
       "enabled": false
     }'

Где:

customerId — идентификатор организации;
userId — идентификатор пользователя;
firstName — имя пользователя, можно изменить;
lastName — фамилия пользователя, можно изменить;
middleName — отчество, можно изменить.

Пример ответа

{
  "user": {
      "user_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
      "username": "ivanovao@gmail.com",
      "email": "ivanovao@gmail.com",
      "first_name": "Ольга",
      "last_name": "Петрова",
      "middle_name": "Ивановна",
      "enabled": false,
      "account_type": "USER_ACCOUNT_TYPE_FEDERATED"
  }
}

См.также

Где найти ID организации?

Была ли статья полезной?