Пользователи

Спецификация OpenAPI

• users
  • getПолучение списка пользователей
  • postСоздание пользователя
  • getПолучение пользователя
  • postПриглашение пользователя

API docs by Redocly

Публичный API (0.0.0)

Публичный API 2ГИС ГеоПоток

users

Получение списка пользователей

Возвращает страницу со списком пользователей.

Authorizations:

BearerAuth

query Parameters

limit required	integer Максимальное число пользователей в ответе, от 1 до 500.
cursor	string Курсор для получения следующей или предыдущей страницы результатов.

Responses

Response Schema: application/json

required	object (CursorResponse) Курсоры следующей и предыдущей страниц результата.
required	Array of objects (UserResponse) Элементы текущей страницы.

URL сервера

https://geoflow.2gis.ru/public/api/v1/users

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "cursor": {

  • "next": "string",
  • "prev": "string"

  },
• "items": [

  • {

    • "first_name": "string",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "last_name": "string",
    • "phone": "string",
    • "roles": [

      • "super_admin"

      ],
    • "second_name": "string",
    • "status": "active",
    • "username": "string"

    }

  ]

}

Создание пользователя

Создаёт пользователя мобильного приложения.

Authorizations:

BearerAuth

Request Body schema: application/json

required

Данные для создания пользователя.

first_name required	string Имя пользователя.
last_name required	string Фамилия пользователя.
phone_number	string non-empty Номер телефона.
second_name	string non-empty Отчество пользователя.
username required	string Логин пользователя.

Responses

Response Schema: application/json

first_name	string Имя пользователя.
id required	string <uuid> Идентификатор пользователя.
last_name	string Фамилия пользователя.
phone	string Номер телефона.
roles required	Array of strings (RoleName) Items Enum: "super_admin" "admin" "dispatcher" "agent_group_admin" "user" Роли пользователя.
second_name	string Отчество пользователя.
status required	string (UserStatus) Enum: "active" "inactive" "pending" Статус учётной записи: active, inactive или pending.
username required	string Логин пользователя.

URL сервера

https://geoflow.2gis.ru/public/api/v1/users

Request samples

• Payload

Content type

application/json

{

• "first_name": "string",
• "last_name": "string",
• "phone_number": "string",
• "second_name": "string",
• "username": "string"

}

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "first_name": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "last_name": "string",
• "phone": "string",
• "roles": [

  • "super_admin"

  ],
• "second_name": "string",
• "status": "active",
• "username": "string"

}

Получение пользователя

Возвращает данные пользователя по его идентификатору.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор пользователя.

Responses

Response Schema: application/json

first_name	string Имя пользователя.
id required	string <uuid> Идентификатор пользователя.
last_name	string Фамилия пользователя.
phone	string Номер телефона.
roles required	Array of strings (RoleName) Items Enum: "super_admin" "admin" "dispatcher" "agent_group_admin" "user" Роли пользователя.
second_name	string Отчество пользователя.
status required	string (UserStatus) Enum: "active" "inactive" "pending" Статус учётной записи: active, inactive или pending.
username required	string Логин пользователя.

URL сервера

https://geoflow.2gis.ru/public/api/v1/users/{id}

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "first_name": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "last_name": "string",
• "phone": "string",
• "roles": [

  • "super_admin"

  ],
• "second_name": "string",
• "status": "active",
• "username": "string"

}

Приглашение пользователя

Отправляет пользователю приглашение с временным паролем для входа в мобильное приложение.

Authorizations:

BearerAuth

Request Body schema: application/json

required

Логин пользователя, которому будет отправлено приглашение.

username required

string Логин пользователя.

Responses

Response Schema: application/json

id required	string <uuid> Идентификатор пользователя.
phone_number	string Номер телефона.
status required	string (UserStatus) Enum: "active" "inactive" "pending" Результат приглашения пользователя по логину.
temporary_password required	string Временный пароль, выданный при приглашении пользователя.
username required	string Логин пользователя.

URL сервера

https://geoflow.2gis.ru/public/api/v1/users/invite/by-login

Request samples

• Payload

Content type

application/json

{

• "username": "string"

}

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "phone_number": "string",
• "status": "active",
• "temporary_password": "string",
• "username": "string"

}