UpdateAccessApplication
Updates an access application.
Operation description
Modifies the configuration of an access application in a workspace to adjust application integration and identity source settings.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
agentcore:UpdateAccessApplication |
update |
*Workspace
|
None | None |
Request syntax
PATCH /workspaces/{workspaceId}/access-applications/{applicationId} HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspaceId |
string |
Yes |
The workspace ID. |
ws-1234567890 |
| applicationId |
string |
Yes |
The access application ID. |
app-1234567890 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
Yes |
The request body for updating the access application. |
|
| applicationName |
string |
No |
The name of the access application. |
my-access-application |
| redirectUris |
array |
No |
The list of redirect URIs. |
|
|
string |
No |
The redirect URI. |
https://example.com/callback |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| requestId |
string |
The request ID. |
1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| message |
string |
The message indicating the request processing result. |
success |
| httpStatusCode |
integer |
The HTTP status code. |
200 |
| code |
string |
The business status code. |
Success |
| success |
boolean |
Indicates whether the request is successful. |
|
| data |
object |
The details of the access application. |
|
| applicationId |
string |
The access application ID. |
app-1234567890 |
| workspaceId |
string |
The workspace ID. |
ws-1234567890 |
| applicationName |
string |
The name of the access application. |
my-access-application |
| userSource |
string |
The user source. Valid values:
|
LOCAL |
| clientId |
string |
The OAuth client ID. |
client-1234567890 |
| metadataUrl |
string |
The metadata URL of the identity provider. |
https://example.com/.well-known/openid-configuration |
| redirectUris |
array |
The list of redirect URIs. |
|
|
string |
The redirect URI. |
https://example.com/callback |
|
| createdAt |
string |
The creation time in RFC 3339 format. |
2026-01-01T00:00:00Z |
| updatedAt |
string |
The update time in RFC 3339 format. |
2026-01-01T00:00:00Z |
Examples
Success response
JSON format
{
"requestId": "1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "success",
"httpStatusCode": 200,
"code": "Success",
"success": false,
"data": {
"applicationId": "app-1234567890",
"workspaceId": "ws-1234567890",
"applicationName": "my-access-application",
"userSource": "LOCAL",
"clientId": "client-1234567890",
"metadataUrl": "https://example.com/.well-known/openid-configuration",
"redirectUris": [
"https://example.com/callback"
],
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | InvalidParameter | |
| 502 | Application.UpstreamFailed | Application.UpstreamFailed | |
| 404 | Workspace.NotFound | Workspace.NotFound | |
| 404 | Application.NotFound | Application.NotFound | |
| 409 | Application.OperationInProgress | Application.OperationInProgress | |
| 409 | Application.UserSourceUnavailable | Application.UserSourceUnavailable |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.