Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /gui_app_framework/application_creation_task/{application_id}/auth

Responds to an authorisation request for an application install.

Responds to an authorisation request for an application install.

The GET operation on /application_creation_task/{application_id}/auth returns the capabilities that were requested by the app. You must supply the ID of a user that has these capabilities.

Table 1: POST /gui_app_framework/application_creation_task/{application_id}/auth Resource Details

MIME Type

application/json

Table 2: POST /gui_app_framework/application_creation_task/{application_id}/auth Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application identifier.

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: POST /gui_app_framework/application_creation_task/{application_id}/auth Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

authorisation

Object

application/json

Required - The granted authorisation:

  • user_id - Long - user ID to be associated with this application.

{ "user_id": 1 }

Table 4: POST /gui_app_framework/application_creation_task/{application_id}/auth Response Codes

HTTP Response Code

Unique Code

Description

200

 

Authorisation was granted.

404

1002

The application identifier could not be found, or no authorisation request exists for the given application identifier.

409

33602

The supplied OAuth user does not have the capabilities required by the application.

409

33700

The application framework is currently disabled.

422

33601

The supplied OAuth user does not exist.

500

33306

An error occurred while parsing the copy of the app manifest stored in the database.

500

1020

The request could not be completed.

Response Description

Confirmation of the granted authorisation:

  • capabilities - Array of String - List of requested capabilities.

  • user_id - Long - Associated user ID.

Response Sample