PATCH
forgeapps/:id
Creates/updates the nickname for the current app. The nickname is used as a clearer alternative name when identifying AppBundles and Activities, as compared to using the Client ID. Once you have defined a nickname, it MUST be used instead of the Client ID.
The new nickname cannot be in use by any other app.
The app cannot have any data when this endpoint is invoked. Use the ‘DELETE /forgeapps/me’ endpoint (cautiously!!!) to remove all data from this app. ‘DELETE /forgeapps/me’ is also the only way to remove the nickname.
Note the nickname is supplied in the body, not as a query-parameter.
Resource Information
Method and URI | PATCH https://developer.api.autodesk.com/da/us-east/v3/forgeapps/:id |
Authentication Context | app only |
Required OAuth Scopes | code:all |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via OAuth |
Content-Type* string | Must be application/json |
* Required
Request
URI Parameters
id string | Must be “me” for the call to succeed. |
Request
Body Structure
Expand all
nickname string | |
publicKey object | |
Exponent string | |
Modulus string |
Response
HTTP Status Code Summary
200 OK | Successfully update the user’s nickname. |
403 Forbidden | Forbidden. |
409 Conflict | Conflict (in use by someone else). |
500 Internal Server Error | Unknown error. |
Example
Successfully update the user’s nickname.
Request
curl -v 'https://developer.api.autodesk.com/da/us-east/v3/forgeapps/:id' \
-X 'PATCH' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"nickname": "",
"publicKey": {
"Exponent": "",
"Modulus": ""
}
}'
Show More
Response