OAuthВыдать токен доступа
Назад к Sofia

OAuth

Выдать токен доступа

Обменивает client_credentials, authorization_code с PKCE или одноразовый refresh_token на непрозрачный токен на 3600 с для одного Workspace.

POSThttps://api.sofia-post.com/api/v1/oauth/token

Тело

application/x-www-form-urlencoded, application/json

  • grant_typestringобязательно

    Обмениваемый grant: client_credentials, authorization_code или refresh_token

    Допустимые значения: client_credentialsauthorization_coderefresh_token

  • client_idstringобязательно

    Идентификатор клиентского приложения

  • client_secretstring

    Секрет конфиденциального клиента (client_secret_post) или в заголовке Authorization: Basic (client_secret_basic), но не оба сразу; для публичного клиента не нужен

  • scopestring

    Запрашиваемые разрешения через пробел; не указано: все разрешения grant

  • workspace_idstring

    Workspace, в котором действует токен: обязателен, если у приложения их несколько при client_credentials, необязателен, если один

  • codestring

    authorization_code: код, полученный на адрес перенаправления

  • code_verifierstring

    authorization_code: верификатор PKCE (RFC 7636)

  • redirect_uristring

    authorization_code: тот же адрес перенаправления, что и при авторизации

  • refresh_tokenstring

    refresh_token: refresh token, одноразовый

Ответ

200application/json

Токен доступа, с refresh_token только если выдан offline_access.

  • access_tokenstringобязательно

    Непрозрачный токен доступа

  • token_typestringобязательно

    Всегда Bearer

    Допустимые значения: Bearer

  • expires_innumberобязательно

    Срок действия в секундах

  • scopestringобязательно

    Выданные разрешения через пробел

  • refresh_tokenstring

    Только для authorization_code и refresh_token, если выдан offline_access: одноразовый, меняется при каждом обмене

400

invalid_request, invalid_grant, unsupported_grant_type, invalid_scope или unauthorized_client.

401

invalid_client: неизвестный клиент, неверный или отсутствующий секрет либо отозванное приложение.