Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3

...

POST /application/

...

Корректировка приложения

Параметры URL

Имя

Тип

Описание

id

string

Обязательный. Id ресурса.

Параметры JSON

...

Имя

...

Тип

...

Add application

JSON parameters

Name

Type

Description

redirect_uris

string

Перенаправление uris. type

name

string

Имя приложения.

trusted

boolean

Если приложение доверенное, то пользовательский логин не потребуется во время авторизации приложения.

default_scopes

string

Область действия по умолчанию.

Поля ответа

Описание

Имя

Тип

One of 'public', 'trusted'. Default: public

name

string

Required.

Resource fields

Name

Type

Description

redirect_uris

stringПеренаправление uris.

create_date

string

name

string

Имя приложения.

secretcreated_by

string

Ключ приложения. access

id

string

Id приложения. secret

trusted

object

Если приложение доверенное, то пользовательский логин не потребуется во время авторизации приложения.

default_scopes

string

Область действия по умолчанию.

DELETE /application/{id}

Удаление приложения

Параметры URL

Имя

Тип

Описание

id

string

Обязательный. Id ресурса. string

Default: visible_only_when_creating_or_resetting

user_id

integer

type

string

id

string

Resource id.

GET /application/

...

Получение приложения по id

Параметры URL

Имя

Тип

Описание

id

string

Обязательный. Id ресурса.

Поля ответа

...

Имя

...

Тип

...

Описание

...

redirect_uris

...

string

...

Перенаправление uris.

...

name

...

string

...

Имя приложения.

...

secret

...

string

...

Ключ приложения.

...

id

...

string

...

Id приложения.

...

trusted

...

object

...

Если приложение доверенное, то пользовательский логин не потребуется во время авторизации приложения.

...

default_scopes

...

string

...

Get applications list

Resource fields

Name

Type

Description

redirect_uris

string

create_date

string

name

string

created_by

string

access

string

secret

string

Default: visible_only_when_creating_or_resetting

user_id

integer

type

string

id

string

Resource id.

...

GET /application/permission/

Получение списка разрешений приложений

Параметры запроса

...

Имя

...

Тип

...

Get applications permissions list

Query parameters

Name

Type

Description

application_id

array [string]

Id приложения.

id

array [integer]Id разрешения авторизации.

auth_id

array [integer]

Id авторизации.

Поля ответа

...

Имя

...

Тип

...

Описание

Resource fields

Name

Type

Description

application_id

string

Id приложения.

id

integer

Id разрешения авторизации.

auth_id

integerId авторизации.

...

id

...

Удаление разрешения приложения по id

Параметры URL

Имя

Тип

Описание

id

integer

Обязательный. Id ресурсаinteger

Resource id.

...

GET /application/permission/{id}

Получение разрешения приложения по Get application permission by id

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

id

integer

ОбязательныйRequired. Id ресурсаResource id.

...

Resource fields

ИмяName

ТипType

ОписаниеDescription

application_id

string

Id приложения.

id

integer

Id разрешения авторизации.

auth_id

integer

Id авторизации.

PUT /application/scopes/{id}

Корректировка application_scopes по id

Параметры URL

Тип

Имя

Описание

id

integer

Обязательный. Id ресурса.

Параметры JSON

Имя

Тип

Описание

name

string

Имя области действия.

description

string

Описание.

Поля ответа

Имя

Тип

Описание

id

integer

Id области деяствия.

name

string

Имя области действия.

description

string

ОписаниеResource id.

DELETE /application/

...

permission/{id}

Удаление application_scopes по Delete application permission by id

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

id

integer

ОбязательныйRequired. Id ресурсаResource id.

...

PUT /application

...

/{id}

Получение Update application_scopes по id

Параметры URL

...

Имя

...

Тип

...

Path parameters

Name

Type

Description

id

integerstring

ОбязательныйRequired. Id ресурсаResource id.

...

JSON parameters

ИмяName

ТипType

ОписаниеDescription

idredirect_uris

integer

Id области деяствия.

namestring

type

stringИмя

области действияOne of 'public', 'trusted'.

descriptionname

string

Описание.

GET /application/token/

Получение списка маркеров приложений

Параметры запроса

Имя

Тип

Описание

scopes

array [string]

Область действий маркера авторизации.

application_id

array [string]

Id приложения.

access_token

array [string]

Маркер доступа.

expires

array [string]

Истечение авторизации маркера.

auth_id

array [integer]

Id авторизации.

token_type

array [string]

Тип маркера.

id

array [integer]

Id авторизации маркера.

refresh_token

array [string]

Обновление маркера.

Поля ответа

Имя

Тип

Описание

expires

string

application_id

string

Id приложения.

id

integer

Id администратора.

auth_id

integer

Id авторизации.

POST /application/scopes/

Добавление нового application_scopes

Параметры JSON

Имя

Тип

Описание

name

string

Обязательный. Имя области действия.

description

string

Обязательный. Описание.

Поля ответа

Имя

Тип

Описание

id

integer

Id области деяствия.

name

string

Имя области действия.

description

string

Описание.

GET /application/scopes/

Получение списка application_scopes

Параметры запроса

Имя

Тип

Описание

id

array [integer]

Id области деяствия.

description

array [string]

Описание.

name

array [string]

Имя области действия.

Поля ответа

Имя

Тип

Описание

id

integer

Id области деяствия.

name

string

Имя области действия.

description

string

Описание.

DELETE /application/token/{id}

Удаление информации маркера приложения

Параметры URL

Имя

Тип

Описание

id

integer

Обязательный. Id ресурса.

GET /application/token/{id}

Получение информации маркера приложения по id

Параметры URL

Имя

Тип

Описание

id

integer

Обязательный. Id ресурса.

Поля ответа

...

Имя

...

Тип

...

Описание

...

expires

...

string

...

application_id

...

string

...

Id приложения.

...

id

...

integer

...

Id администратора.

...

auth_id

...

integer

...

Resource fields

Name

Type

Description

redirect_uris

string

create_date

string

name

string

created_by

string

access

string

secret

string

Default: visible_only_when_creating_or_resetting

user_id

integer

type

string

id

string

Resource id.

GET /application/{id}

Get application by id

Path parameters

Name

Type

Description

id

string

Required. Resource id.

Resource fields

Name

Type

Description

redirect_uris

string

create_date

string

name

string

created_by

string

access

string

secret

string

Default: visible_only_when_creating_or_resetting

user_id

integer

type

string

id

string

Resource id.

DELETE /application/{id}

Delete application

Path parameters

Name

Type

Description

id

string

Required. Resource id.

...

PUT /application/{id}/reset_secret/

Сброс ключа приложения

Параметры URL

...

Имя

...

Тип

...

Reset application secret

Path parameters

Name

Type

Description

id

string

ОбязательныйRequired. Id ресурсаResource id.

POST /application/

Добавление приложения

Параметры JSON

...

Имя

...

Тип

...

Описание

Resource fields

Name

Type

Description

redirect_uris

string

Перенаправление uris.

name

string

Обязательный. Имя приложения.

trusted

boolean

Если приложение доверенное, то пользовательский логин не потребуется во время авторизации приложения. Значение по умолчанию: False

default_scopes

string

Область действия по умолчанию.

Поля ответа

Имя

Тип

Описание

redirect_uris

string

Перенаправление uris.

name

string

Имя приложения.

secret

string

Ключ приложения.

id

string

Id приложения.

trusted

object

Если приложение доверенное, то пользовательский логин не потребуется во время авторизации приложения.

default_scopes

string

Область действия по умолчанию.

GET /application/

Получение списка приложений

Поля ответа

Имя

Тип

Описание

redirect_uris

string

Перенаправление uris.

name

string

Имя приложения.

secret

string

Ключ приложения.

id

string

Id приложения.

trusted

object

Если приложение доверенное, то пользовательский логин не потребуется во время авторизации приложения.

default_scopes

string

Область действия по умолчаниюcreate_date

string

name

string

created_by

string

access

string

secret

string

Default: visible_only_when_creating_or_resetting

user_id

integer

type

string

id

string

Resource id.

...