Jump to

• Request
• Response

Update an Application

put

/api/v2/applications/{id}/

Make a PUT or PATCH request to this resource to update this application. The following fields may be modified:

• name: Name of this application. (string, required)

• description: Optional description of this application. (string, default="")

• client_type: Set to Public or Confidential depending on how secure the client device is. (choice, required)

  • confidential: Confidential
  • public: Public
• redirect_uris: Allowed URIs list, space separated (string, default="")
• authorization_grant_type: The Grant type the user must use for acquire tokens for this application. (choice, required)
  • authorization-code: Authorization code
  • password: Resource owner password-based
• skip_authorization: Set True to skip authorization step for completely trusted applications. (boolean, default=False)
• organization: Organization containing this application. (id, required)

For a PUT request, include all fields in the request.

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Query Parameters

• search(optional): string
  A search term.

Body ()

Root Schema : schema

Type: object

Show Source

• authorization_grant_type: string
  The Grant type the user must use for acquire tokens for this application.
• client_type: string
  Set to Public or Confidential depending on how secure the client device is.
• description(optional): string
• name: string
• organization: integer
  Organization containing this application.
• redirect_uris(optional): string
  Allowed URIs list, space separated
• skip_authorization(optional): boolean
  Set True to skip authorization step for completely trusted applications.

{
    "properties":{
        "authorization_grant_type":{
            "description":"The Grant type the user must use for acquire tokens for this application.",
            "type":"string"
        },
        "client_type":{
            "description":"Set to Public or Confidential depending on how secure the client device is.",
            "type":"string"
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "organization":{
            "description":"Organization containing this application.",
            "type":"integer"
        },
        "redirect_uris":{
            "description":"Allowed URIs list, space separated",
            "type":"string"
        },
        "skip_authorization":{
            "description":"Set True to skip authorization step for completely trusted applications.",
            "type":"boolean"
        }
    },
    "required":[
        "name",
        "client_type",
        "authorization_grant_type",
        "organization"
    ],
    "type":"object"
}

Back to Top

Response

200 Response

Back to Top