- URL:
- https://<root>/security/oauth/changeAppID
- Methods:
POST- Version Introduced:
- 10.3
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The change operation changes the client ID of a registered application to a new value. When new applications are registered with an organization, a new client ID is generated for the application. This allows the application to access the organization's content. However, the new client ID does not work if the application developer has programmed against a specific ID. In these instances, this operation can be called to modify the client ID and allow the registered application to access the organization.
Request parameters
| Parameter | Details |
|---|---|
| The current client ID of an existing application. Example |
| The new client ID to assign to the application. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the change operation:
POST /<context>/portaladmin/security/oauth/changeAppID HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
currentAppID=sj290209shsnw&newAppID=wejjoi8723902&f=jsonJSON Response example
{"status": "success"}