Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

...

maxLevel

...

3

...

...

POST /application/

...

Delete Add application

...

JSON parameters

ИмяName

Тип

Описание

id

string

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

GET /application/{id}

Get application by id

Параметры URL

Имя

Тип

Описание

id

string

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

Поля ответа

Имя

Тип

Описание

Type

Description

redirect_uris

string

Application redirect uris

nametype

string

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

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

name

string

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

owner

integer

Application owner

id

string

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

trusted

string

default_scopes

string

Application default scopes

PUT /application/{id}

Update application

Параметры URL

Имя

Тип

Описание

id

string

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

Параметры JSON

Имя

Тип

Описание

owner

integer

Application ownerRequired.

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_uriscreated_by

string

Application redirect urisaccess

name

string

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

secret

string

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

ownerDefault: visible_only_when_creating_or_resetting

user_id

integer

Application ownertype

id

string

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

trusted

string

default_scopes

string

Application default scopes

PUT /application/{id}/reset_secret/

Reset application secret

Параметры URL

Имя

Тип

Описание

id

string

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

GET /application/

Get applications list

...

Resource fields

ИмяName

ТипType

ОписаниеDescription

redirect_uris

string

Application redirect uris

namecreate_date

string

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

string

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

owner

integer

Application owner

id

string

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

trusted

string

default_scopes

string

Application default scopes

POST /application/

Add application

Параметры JSON

Имя

Тип

Описание

owner

integer

Application owner

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

Поля ответа

Имя

Тип

Описание

redirect_uris

string

Application redirect uris

name

string

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

secret

string

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

owner

integer

Application owner

id

string

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

trusted

string

default_scopes

string

Application default scopes

DELETE /application/scopes/{id}

Delete application_scopes by id

Параметры URL

Имя

Тип

Описание

id

integer

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

...

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

array [integer]

auth_id

array [integer]

Resource fields

Name

Type

Description

application_id

string

auth_id

integer

id

integer

Resource id.

...

GET /application/permission/{id}

Get application _scopes permission by id

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

id

integer

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

...

Resource fields

ИмяName

ТипType

ОписаниеDescription

descriptionapplication_id

string

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

name

string

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

integer

id

integer

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

...

DELETE /application/

...

permission/{id}

Update Delete application _scopes permission by id

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

Имя

Тип

Описание

expires

string

application_id

string

id

integer

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

Параметры 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

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

Имя

Тип

Описание

description

string

Application scopes description

name

string

Application scopes name

id

integer

Application scopes id

Поля ответа

Имя

Тип

Описание

description

string

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

name

string

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

id

integer

Обязательный. Application scopes 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

DELETE /application/permission/{id}

Delete application permission by id

Параметры URL

Имя

Тип

Описание

id

integer

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

GET /application/permission/{id}

Get application permission by id

Параметры URL

Имя

Тип

Описание

id

integer

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

Поля ответа

Имя

Тип

Описание

application_id

string

Обязательный. Auth permission application id

auth_id

integer

Обязательный. Auth permission auth id

id

integer

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

GET /application/permission/

Get applications permissions list

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

Имя

Тип

Описание

application_id

string

Auth permission application id

id

integer

Auth permission id

auth_id

integer

Auth permission auth id

Поля ответа

Имя

Тип

Описание

application_id

string

Обязательный. Auth permission application id

auth_id

integer

Обязательный. Auth permission auth id

id

integer

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

DELETE /application/token/{id}

Delete application token info

Параметры URL

Имя

Тип

Описание

id

integer

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

GET /application/token/{id}

Get application token info by id

Параметры URL

Имя

Тип

Описание

id

integer

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

Поля ответа

Имя

Тип

Описание

expires

string

application_id

string

auth_id

string

id

string

Resource id

GET /application/token/

Get application token list

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

Имя

Тип

Описание

scopes

string

Auth token scopes

application_id

string

Auth token application id

access_token

string

Auth token access token

expires

string

Auth token expires

id

integer

Auth token id

token_type

string

Auth token token type

auth_id

integer

Auth token auth id

refresh_token

string

Auth token refresh token

Поля ответа

auth_idRequired. Resource id.

...

PUT /application/{id}

Update application

Path parameters

Name

Type

Description

id

string

Required. Resource id.

JSON parameters

Name

Type

Description

redirect_uris

string

type

string

One of 'public', 'trusted'.

name

string

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/

Reset application secret

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.

...