mutation · Module: Apps · Requires connections:write
Arguments
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
input | AppUpdate | The fields for this operation. |
AppUpdate fields
| Field | Type |
|---|---|
name | String |
scopes | [String!] |
visibility | AppUpdateVisibility |
client_secret | String |
status | AppUpdateStatus |
user_metadata | UserMetadataInput |
Returns
App!
| Field | Type |
|---|---|
id | String! |
object | AppObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
carrier | String! |
name | String |
client_id | String! |
client_secret | String |
client_secret_preview | String |
client_secret_expires_at | Int |
redirect_uris | [String!] |
scopes | [String!] |
issuer | String |
openid | Boolean |
token_endpoint_auth_method | AppTokenEndpointAuthMethod |
pkce | AppPkce |
registration | AppRegistration! |
visibility | AppVisibility |
status | AppStatus |
connection_count | Int |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation UpdateApp($id: ID!, $input: AppUpdate!) {
updateApp(id: $id, input: $input) {
id
object
name
status
livemode
created
updated
carrier
client_id
client_secret
client_secret_preview
client_secret_expires_at
redirect_uris
scopes
issuer
openid
}
}
{
"id": "app_1a2B3c",
"input": {
"name": "Example",
"scopes": [
"example"
],
"visibility": "private",
"client_secret": "example",
"status": "active"
}
}
{
"data": {
"updateApp": {
"id": "app_1a2B3c",
"object": "app",
"name": "Example",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"carrier": "dhl_express",
"client_id": "0oa1b2c3",
"client_secret": "example",
"client_secret_preview": "example",
"client_secret_expires_at": 1791302400,
"redirect_uris": [
"example"
],
"scopes": [
"example"
],
"issuer": "https://ada.okta.com/oauth2/default",
"openid": true
}
}
}