Company: Access

🔒 Проверка наличия пользователя и его доступа/ролей в текущей компании по телефону или email (#26890).

Проверка наличия пользователя и его доступа/ролей в текущей компании по телефону или email (#26890).

Access: authorized (10 ) · Scope: read

Allows: user:create, user:invite (все обязательны; проверка в команде по ресурсу из запроса)

TypeScript (copy-paste)

GET /company/access/check-user

<details open><summary><b>Params</b></summary>
export interface CompanyAccessCheckUserParams {
  /** Phone number */
  phone?: string | null
  email?: string | null
}
</details> <details open><summary><b>Response</b></summary>
export type CompanyAccessCheckUserResponse = IServerResponse<Resp_company_access_check-user>

export interface IServerResponse<T = any> {
  code: number
  data: T
  srvTS: number
  rkey: string
}
</details>

Полный файл типов: /docs/types · raw: /docs/api-types.ts

get/company/access/check-user

Request

  • Base URL: http://localhost
  • URL: http://localhost/company/access/check-user
  • Auth: one of:
    • API key in header sid and API key in header rts and API key in header sig
    • HTTP bearer

Query parameters

phonestring nullable

Phone number

Можно передать header phone (сервер мержит headers+query)

emailstring nullable

Можно передать header email (сервер мержит headers+query)

Headers

devIDstring uuid required

UUID устройства клиента

tzstring required
Example:Europe/Moscow

Таймзона клиента (IANA или offset)

appstring required
Example:kosmodrom-web

Имя клиентского приложения

appVerstring required
Example:1.0.0

Версия клиента

rKeystring

Уникальный ключ запроса для логов/саппорта

Response

OK — IServerResponse<Resp_company_access_check-user>

codeinteger required
srvTSinteger required

Server timestamp (ms)

rkeystring required

Request key

Example response

{
  "code": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.