Versions Compared

Key

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

External application

...

Table of Contents
maxLevel3

POST /application/

...

Delete Add application

...

JSON parameters

...

Name

Type

Description

idredirect_uris

string

type

string

Required. Resource id

GET /application/{id}

Get application by id

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

name

string

Required.

Resource fields

id

Name

Type

Description

redirect_uris

string

create_date

string

name

string

created_by

string

access

string

Required. Resource id

PUT /application/{id}

Update application

Path parameters

Description

Name

Type

secret

string

Default: visible_only_when_creating_or_resetting

user_id

integer

type

string

id

string

Required. Resource id

...

.

GET /application/

Get applications list

Resource fields

...

owner

Name

Type

Description

integer

Application owner

redirect_uris

stringApplication redirect uris

create_date

string

name

string

Application name

trusted

boolean

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

default_scopes

string

Application default scopes

PUT /application/{id}/reset_secret/

Reset application secret

Path parameters

Name

Type

Description

id

string

Required. Resource id

GET /application/

Get applications list

POST /application/

Add application

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

owner

integer

Application owner

redirect_uris

string

Application redirect uris

name

string

Required. Application name

trusted

boolean

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

default_scopes

string

Application default scopes

...

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}

Delete Get application _scopes permission by id

Path parameters

Name

Type

Description

id

integer

Required. Resource id.

Resource fields

Name

Type

Description

application_id

string

auth_id

integer

id

integer

Resource id.

...

DELETE /application/

...

permission/{id}

Get Delete application _scopes permission by id

Path parameters

Name

Type

Description

id

integer

Required. Resource id.

...

PUT /application

...

/{id}

Update application_scopes by id

Path parameters

Name

Type

Description

id

integerstring

Required. Resource id.

JSON parameters

...

Name

Type

Description

descriptionredirect_uris

string

Application scopes descriptiontype

name

string

Application scopes name

GET /application/scopes/

Get application_scopes list

string

One of 'public', 'trusted'.

name

string

Resource fields

...

Name

Type

Description

descriptionredirect_uris

stringApplication scopes description

create_date

string

name

string

Application scopes name

id

integer

Application scopes id

POST /application/scopes/

Add new application_scopes

JSON parameters

Name

Type

Description

description

string

Required. Application scopes description

name

string

Required. Application scopes name

DELETE /application/permission/{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/{id}

Get application by id

Path parameters

Name

Type

Description

id

integerstring

Required. Resource id

GET /application/permission/{id}

Get application permission by id

...

.

Resource fields

Name

Type

Description

id

integer

Required. Resource id

GET /application/permission/

Get applications permissions list

Query parameters

Name

Type

Description

application_id

string

Auth permission application id

id

integer

Auth permission id

auth_id

integer

Auth permission auth id

...

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/

Get application token info by idReset application secret

Path parameters

Name

Type

Description

id

integerstring

Required. Resource id

GET /application/token/

Get application token list

...

.

Resource fields

Name

Type

Description

scopesredirect_uris

string

Auth token scopes

application_idcreate_date

string

Auth token application id

access_tokenname

string

created_by

string

Auth token access token

string

expiressecret

string

Auth token expires

Default: visible_only_when_creating_or_resetting

user_id

integerAuth token id

token_type

stringAuth token token type

auth_id

integerstring

Auth token auth id

refresh_token

string

Auth token refresh tokenResource id.

...