Jump to

• Request
• Response

Update an Application

patch

/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 PATCH request, include only the fields that are being modified.

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Query Parameters

• search(optional): string
  A search term.

Body ()

Root Schema : schema

Example:

{
    "authorization_grant_type":"password",
    "name":"Test app with immutable grant type and user",
    "organization":1,
    "redirect_uris":"http://localhost/api/",
    "skip_authorization":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body

Example Response (application/json)

{
    "authorization_grant_type":"password",
    "client_id":"xxxx",
    "client_secret":"************",
    "client_type":"confidential",
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "id":1,
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"Test app with immutable grant type and user",
    "organization":1,
    "redirect_uris":"http://localhost/api/",
    "related":{
        "activity_stream":"/api/v2/applications/1/activity_stream/",
        "tokens":"/api/v2/applications/1/tokens/"
    },
    "skip_authorization":true,
    "summary_fields":{
        "organization":{
            "description":"test-org-desc",
            "id":1,
            "name":"test-org"
        },
        "tokens":{
            "count":0,
            "results":[
            ]
        },
        "user":{
            "first_name":"",
            "id":1,
            "last_name":"",
            "username":"admin"
        },
        "user_capabilities":{
            "delete":true,
            "edit":true
        }
    },
    "type":"o_auth2_application",
    "url":"/api/v2/applications/1/"
}

Back to Top