Versions Compared

Key

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

...

POST /application/

...

Update application

Параметры URL

Имя

Тип

Описание

id

string

Обязательный. Resource id.

Параметры JSON

...

Имя

...

Тип

...

Описание

...

owner

...

integer

...

Application owner.

Add application

JSON parameters

Name

Type

Description

redirect_uris

string

Application redirect uris.

name

string

Application name.

trusted

boolean

If app is trusted, no user login required during app authorization.

default_scopes

string

Application default scopes.

Поля ответа

Описание

Имя

Тип

type

string

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

name

string

Required.

Resource fields

Name

Type

Description

redirect_uris

string

Application redirect uris.

namecreate_date

string

Application name. secret

string

Application secret.

owner

integer

Application owner.

id

string

Application id.

trusted

object

If app is trusted, no user login required during app authorization.

default_scopes

string

Application default scopescreated_by

string

access

string

secret

string

Default: visible_only_when_creating_or_resetting

user_id

integer

type

string

id

string

Resource id.

GET /application/

...

Get application by id

Параметры URL

Имя

Тип

Описание

id

string

Обязательный. Resource id.

Поля ответа

...

Имя

...

Тип

...

Описание

Get applications list

Resource fields

Name

Type

Description

redirect_uris

string

Application redirect uris.

namecreate_date

string

Application name.

secret

string

Application secret.

owner

integer

Application owner.

id

string

Application id.

trusted

object

If app is trusted, no user login required during app authorization.

default_scopes

string

Application default scopes.

DELETE /application/{id}

Delete application

Параметры URL

Имя

Тип

Описание

id

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]

Auth permission application id. id

array [integer]

Auth permission id.

auth_id

array [integer]

Auth permission auth id.

Поля ответа

...

Имя

...

Тип

...

Resource fields

Name

Type

Description

application_id

stringAuth permission application id.

auth_id

integerAuth permission auth id.

id

integer

Auth permission Resource id.

...

GET /application/permission/{id}

Get application permission by id

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

id

integer

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

...

Resource fields

ИмяName

ТипType

ОписаниеDescription

application_id

string

Auth permission application id.

auth_id

integerAuth permission auth id.

id

integer

Auth permission Resource id.

DELETE /application/permission/{id}

Delete application permission by id

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

id

integer

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

...

PUT /application

...

/{id}

Update application_scopes by id

Параметры URL

...

Имя

...

Тип

...

Path parameters

Name

Type

Description

id

integerstring

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

...

JSON parameters

ИмяName

ТипType

ОписаниеDescription

descriptionredirect_uris

string

Application scopes description.

Имя

Тип

Описание

description

string

Application scopes description.

nametype

string

Application scopes name.

Поля ответа

One of 'public', 'trusted'.

name

string

Application scopes name.

id

integer

Application scopes id.

GET /application/scopes/{id}

Get application_scopes by id

Параметры URL

Имя

Тип

Описание

id

integer

Обязательный. Resource id.

Поля ответа

Имя

Тип

Описание

description

string

Application scopes description.

name

string

Application scopes name.

id

integer

Application scopes id.

DELETE /application/scopes/{id}

Delete application_scopes by id

Параметры URL

Имя

Тип

Описание

id

integer

Обязательный. Resource id.

GET /application/token/

Get application token list

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

Имя

Тип

Описание

scopes

array [string]

Auth token scopes.

application_id

array [string]

Auth token application id.

access_token

array [string]

Auth token access token.

expires

array [string]

Auth token expires.

auth_id

array [integer]

Auth token auth id.

token_type

array [string]

Auth token token type.

id

array [integer]

Auth token id.

refresh_token

array [string]

Auth token refresh token.

Поля ответа

Имя

Тип

Описание

expires

string

application_id

string

Auth permission application id.

auth_id

integer

Auth permission auth id.

id

integer

Resource id.

POST /application/scopes/

Add new application_scopes

Параметры JSON

Имя

Тип

Описание

description

string

Обязательный. Application scopes description.

name

string

Обязательный. Application scopes name.

Поля ответа

Имя

Тип

Описание

description

string

Application scopes description.

name

string

Application scopes name.

id

integer

Application scopes id.

GET /application/scopes/

Get application_scopes list

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

Имя

Тип

Описание

id

array [integer]

Application scopes id.

description

array [string]

Application scopes description.

name

array [string]

Application scopes name.

Поля ответа

Имя

Тип

Описание

description

string

Application scopes description.

name

string

Application scopes name.

id

integer

Application scopes id.

GET /application/token/{id}

Get application token info by id

Параметры URL

Имя

Тип

Описание

id

integer

Обязательный. Resource id.

Поля ответа

...

Имя

...

Тип

...

Описание

...

expires

...

string

...

application_id

...

string

...

Auth permission application id.

...

auth_id

...

integer

...

Auth permission auth id.

...

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.

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 token info

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

id

integerstring

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

...

PUT /application/{id}/reset_secret/

Reset application secret

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

id

string

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

POST /application/

Add application

Параметры JSON

...

Имя

...

Тип

...

Описание

...

owner

...

integer

...

Application owner.

Resource fields

Name

Type

Description

redirect_uris

string

Application redirect uris.

namecreate_date

string

Обязательный. Application name. trusted

boolean

If app is trusted, no user login required during app authorization.

default_scopes

string

Application default scopes.

Поля ответа

Имя

Тип

Описание

redirect_uris

string

Application redirect uris.

name

string

Application name.

secret

string

Application secret.

owner

integer

Application owner.

id

string

Application id.

trusted

object

If app is trusted, no user login required during app authorization.

default_scopes

string

Application default scopes.

GET /application/

Get applications list

Поля ответа

Имя

Тип

Описание

redirect_uris

string

Application redirect uris.

name

string

Application name.

secret

string

Application secret.

owner

integer

Application owner.

id

string

Application id.

trusted

object

If app is trusted, no user login required during app authorization.

default_scopes

string

Application default scopesstring

created_by

string

access

string

secret

string

Default: visible_only_when_creating_or_resetting

user_id

integer

type

string

id

string

Resource id.

...