OAuth-приложения

Список OAuth-клиентов

Авторизация

АвторизацияBearer <токен>

В: header

Тело ответа

`application/json`

curl -X GET "https://loading/api/v1/security/oauth/clients"

{
  "clients": [
    {
      "allowedAudiences": [
        "string"
      ],
      "applicationType": "web",
      "clientId": "string",
      "clientType": "public",
      "clientUri": "string",
      "contacts": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "grantTypes": [
        "string"
      ],
      "id": "string",
      "isActive": true,
      "jwksUri": "string",
      "lastUsedAt": "2019-08-24T14:15:22Z",
      "logoUri": "string",
      "name": "string",
      "policyUri": "string",
      "redirectUris": [
        "string"
      ],
      "requireDpop": true,
      "requirePkce": true,
      "scopes": [
        "string"
      ],
      "tokenEndpointAuthMethod": "string",
      "tosUri": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Создать OAuth-клиента

Авторизация

АвторизацияBearer <токен>

В: header

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

allowedAudiences?array<string>

Разрешённые audience для выдаваемых токенов

По умолчанию[]

applicationType?string

Тип приложения: web, native или spa

Значение в"web" | "native" | "spa"

clientType*string

Тип клиента: confidential — хранит секрет (сервер), public — без секрета (SPA, мобильные)

Значение в"public" | "confidential"

clientUri?string

Сайт приложения

Форматuri

contacts?array<>

Контактные email ответственных, до 10

По умолчанию[]

Элементыitems <= 10

description?string

Описание назначения клиента

Длинаlength <= 2000

grantTypes*array<>

Разрешённые OAuth grant-типы

Элементы1 <= items

jwksUri?string

JWKS-URL клиента для private_key_jwt

Форматuri

logoUri?string

Логотип приложения

Форматuri

name*string

Название клиента

Длина1 <= length <= 255

policyUri?string

Политика конфиденциальности приложения

Форматuri

redirectUris?array<>

Разрешённые redirect URI для authorization_code

По умолчанию[]

requireDpop?boolean

Требовать DPoP-привязку токенов

requirePkce?boolean

Требовать PKCE для authorization_code

scopes?array<>

Разрешённые scope (см. GET /api/v1/scopes)

По умолчанию[]

tokenEndpointAuthMethod?string

Способ аутентификации на token endpoint

Значение в"client_secret_basic" | "client_secret_post" | "private_key_jwt" | "tls_client_auth" | "none"

tosUri?string

Условия использования приложения

Форматuri

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/security/oauth/clients" \  -H "Content-Type: application/json" \  -d '{    "clientType": "public",    "grantTypes": [      "client_credentials"    ],    "name": "string"  }'

{
  "client": {
    "allowedAudiences": [
      "string"
    ],
    "applicationType": "web",
    "clientId": "string",
    "clientType": "public",
    "clientUri": "string",
    "contacts": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "grantTypes": [
      "string"
    ],
    "id": "string",
    "isActive": true,
    "jwksUri": "string",
    "lastUsedAt": "2019-08-24T14:15:22Z",
    "logoUri": "string",
    "name": "string",
    "policyUri": "string",
    "redirectUris": [
      "string"
    ],
    "requireDpop": true,
    "requirePkce": true,
    "scopes": [
      "string"
    ],
    "tokenEndpointAuthMethod": "string",
    "tosUri": "string",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "clientSecret": "string"
}

Получить OAuth-клиента

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Внутренний идентификатор записи клиента

Тело ответа

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/security/oauth/clients/string"

{
  "client": {
    "allowedAudiences": [
      "string"
    ],
    "applicationType": "web",
    "clientId": "string",
    "clientType": "public",
    "clientUri": "string",
    "contacts": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "grantTypes": [
      "string"
    ],
    "id": "string",
    "isActive": true,
    "jwksUri": "string",
    "lastUsedAt": "2019-08-24T14:15:22Z",
    "logoUri": "string",
    "name": "string",
    "policyUri": "string",
    "redirectUris": [
      "string"
    ],
    "requireDpop": true,
    "requirePkce": true,
    "scopes": [
      "string"
    ],
    "tokenEndpointAuthMethod": "string",
    "tosUri": "string",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Обновить OAuth-клиента

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Внутренний идентификатор записи клиента

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

allowedAudiences?array<string>

Полный новый список audience

clientUri?|

Сайт приложения (null — удалить)

Форматuri

contacts?array<>

Полный новый список контактных email

Элементыitems <= 10

description?|

Новое описание (null — удалить)

Длинаlength <= 2000

isActive?boolean

Активность клиента (false — выданные токены перестают действовать)

jwksUri?|

JWKS-URL клиента (null — удалить)

Форматuri

logoUri?|

Логотип приложения (null — удалить)

Форматuri

name?string

Новое название клиента

Длина1 <= length <= 255

policyUri?|

Политика конфиденциальности (null — удалить)

Форматuri

redirectUris?array<>

Полный новый список redirect URI

requireDpop?boolean

Требовать DPoP-привязку токенов

requirePkce?boolean

Требовать PKCE для authorization_code

scopes?array<>

Полный новый список scope

tosUri?|

Условия использования (null — удалить)

Форматuri

Тело ответа

`application/json`

curl -X PATCH "https://loading/api/v1/security/oauth/clients/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "client": {
    "allowedAudiences": [
      "string"
    ],
    "applicationType": "web",
    "clientId": "string",
    "clientType": "public",
    "clientUri": "string",
    "contacts": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "grantTypes": [
      "string"
    ],
    "id": "string",
    "isActive": true,
    "jwksUri": "string",
    "lastUsedAt": "2019-08-24T14:15:22Z",
    "logoUri": "string",
    "name": "string",
    "policyUri": "string",
    "redirectUris": [
      "string"
    ],
    "requireDpop": true,
    "requirePkce": true,
    "scopes": [
      "string"
    ],
    "tokenEndpointAuthMethod": "string",
    "tosUri": "string",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Удалить OAuth-клиента

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Внутренний идентификатор записи клиента

Тело ответа

`application/json`

curl -X DELETE "https://loading/api/v1/security/oauth/clients/string"

{
  "message": "string"
}

Сгенерировать новый client secret

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Внутренний идентификатор записи клиента

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/security/oauth/clients/string/rotate-secret"

{
  "client": {
    "allowedAudiences": [
      "string"
    ],
    "applicationType": "web",
    "clientId": "string",
    "clientType": "public",
    "clientUri": "string",
    "contacts": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "grantTypes": [
      "string"
    ],
    "id": "string",
    "isActive": true,
    "jwksUri": "string",
    "lastUsedAt": "2019-08-24T14:15:22Z",
    "logoUri": "string",
    "name": "string",
    "policyUri": "string",
    "redirectUris": [
      "string"
    ],
    "requireDpop": true,
    "requirePkce": true,
    "scopes": [
      "string"
    ],
    "tokenEndpointAuthMethod": "string",
    "tosUri": "string",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "clientSecret": "string"
}

OAuth-приложения

200application/json

201application/json

200application/json

404application/problem+json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/problem+json`

`application/json`

`application/json`

`application/json`