Update Organization OAuth Application By Organization ID And Application ID
DescriptionUpdate Organization Managed OAuth App that was created and is owned by the organization
Important:
Changing the client secret via the client management APIs will reset existing secret rotation (meaning, the provided secret in the management APIs will be the only valid secret).
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
| Developer | ✔️ | ✔️ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
The unique identifier of the OAuth Application (client).
Request Body
{
"description": "string",
"displayName": "string",
"grantTypes": [
"string"
]
}
The description of the organization OAuth Application (client).
The OAuth grant types. Customer organizations support the following grant types: authorization_code, refresh_token, and client_credentials. Service organizations additionally support the following grant types: audience_exchange, client_delegate, and context_switch.
The organization OAuth Application display name.
The value must be alphanumerical and can contain the following symbols -_.`’:@&, and space. International characters are allowed.
The organization OAuth Application access token time to live in seconds.
Allowed Organizations.
Can be used to restrict the client to sub-set of organizations.
The value is a list of organizations IDs, in which users may login using this client. If value is not presented in the request (null value) the client will not be restricted.
Important:
1. This option is available only for service organizations. Consumer organizations cannot pass this value since the client is restricted only to it’s managed organization, which cannot be changed.
2. It is not possible to update an organization/s restricted client to be a regular client.
3. The ‘allowedOrgs’ is ignored during client_credentials flow.
4. If an organization is deleted, its references in allowedOrgs are deleted eventually. ‘allowedOrgs’ may become empty if an organization gets deleted, which means users cannot login to any organization using this client. The ‘allowedOrgs’ will be ignored during client_credentials flow.
The allowed general, organization and service scopes of access.
The List of other OAuth App identifiers who can act on behalf of this OAuth App
The List of other OAuth App identifiers who can exchange id token from this OAuth App
When set to true, the flag mandates the use of PKCE when doing an authorization_code flow (i.e., the request will fail if PKCE is not used).
Additional attribute masks. Refer to GAZ docs.
Temporary flag used to request de-dup of domain name in ID token by setting value to ‘false’.
Limit the number of text characters that will be put in the access token. If the resulting access token would exceed this value, an overflow behavior will be triggered. If overflow is triggered, the returned access token will contain a claim ‘ovc’ that lists the claims which have overflowed. For example ‘ovc’ : [‘perms’, ‘authorization_details’]. When overflow is triggered, the token will also contain an ‘ovl’ claim containing a URL which can be can be used to expand the access token and return the claims as JSON. For example ‘ovl’: ‘https://gaz.csp-vidm-prod.com/api/check_access_token' When ‘maxCharactersInAccessToken’ is not set (the default), a system defined value will be used. Currently this value is 3415 characters, or about 5KB. The purpose of this behavior is to help ensure that the request headers containing the JWT access token do not become arbitrarily large. Your system must be able to handle a token that contains ‘ovc’ and ‘ovl’ claims.
The maximum number of groups allowed in the ID token. In case the user is a member in more groups than the value specified in the OAuth client, a URL will be attached to the ID token under the ‘ovl’ claim.
When set to ’true’, the client is not allowed to rotate its own secret. Client rotation will be enabled for organization owner/service owner only using client rotation management APIs. By default, client is enabled to self-rotate its secret.
Post logout redirect URIs, can be used by a service as a custom redirect destination after logout. For e.g., the service login/home page. Relevant only for authorization_code grant type. The PATCH operation will override the entire existing list.
The organization OAuth Application redirect URIs.. Relevant only for authorization_code grant type
The organization OAuth Application refresh token time to live in seconds.
The organization OAuth Application secret
Important:
Changing the client secret via the client management APIs will reset existing secret rotation (meaning, the provided secret in the management APIs will be the only valid secret).
The secret rotation expiration in seconds. The old OAuth Application secret will expire after it. If not specified, the default expiration time is 48 hours.
Optionally override the default number of seconds before a new OAuth Application secret will automatically be rotated when using the OAuth Application secret rotation APIs.
Service definition ID of the service using this authorization code webapp. Required in production for tracking purposes.
Temporary flag used to request issuer URL to be set to CSP URL so that it is OIDC compliant (Default false, but will be changed to true after deprecation cycle).
Authentication
Response
Response BodyResponse Body
200 OK
{
"accessTokenTTL": 0,
"additionalAttributeMasks": [
"string"
],
"allowOpenRedirectUris": false,
"allowedActorsAudienceExchange": [
"string"
],
"allowedActorsClientDelegate": [
"string"
],
"allowedOrgs": [
{
"displayName": "string",
"id": "string",
"name": "string"
}
],
"allowedScopes": {
"generalScopes": [
"string"
],
"organizationScopes": {
"allPermissions": false,
"allRoles": false,
"keptInToken": [
"ROLES"
],
"permissions": [
{
"permissionId": "string",
"resources": [
"string"
]
}
],
"roles": [
{
"name": "string",
"resource": "string"
}
]
},
"servicesScopes": [
{
"allPermissions": false,
"allRoles": false,
"keptInToken": [
"ROLES"
],
"permissions": [
{
"permissionId": "string",
"resources": [
"string"
]
}
],
"roles": [
{
"name": "string",
"resource": "string"
}
],
"serviceDefinitionId": "string"
}
]
},
"createdAt": 0,
"createdBy": "string",
"description": "string",
"displayName": "string",
"forcePkce": false,
"grantTypes": [
"string"
],
"groupDomainAppendedInIDToken": false,
"id": "string",
"immutable": false,
"lastUpdatedAt": 0,
"lastUpdatedBy": "string",
"maxAdditionalAttributesInIdToken": 0,
"maxCharactersInAccessToken": 0,
"maxGroupsInIdToken": 0,
"organizationId": "string",
"ownerOnlySecretRotation": false,
"postLogoutRedirectUris": [
"string"
],
"publicClient": false,
"redirectUris": [
"string"
],
"refreshTokenTTL": 0,
"secretRotationExpirationInSeconds": 0,
"serviceDefinitionId": "string",
"useCspIssuerUrl": false
}
The organization OAuth Application access token time to live in seconds.
Additional attribute masks. Refer to GAZ docs.
Allow client to use open redirections in non-production environments.
The List of other OAuth App identifiers who can exchange id token from this OAuth App
The List of other OAuth App identifiers who can act on behalf of this OAuth App
Allowed Organizations.
Can be used to restrict the client to sub-set of organizations.
The value is a list of organizations IDs, in which users may login using this client. If value is not presented in the request (null value) the client will not be restricted.
Important:
1. This option is available only for service organizations. Consumer organizations cannot pass this value since the client is restricted only to it’s managed organization, which cannot be changed.
2. It is not possible to update an organization/s restricted client to be a regular client.
3. The ‘allowedOrgs’ is ignored during client_credentials flow.
4. If an organization is deleted, its references in allowedOrgs are deleted eventually. ‘allowedOrgs’ may become empty if an organization gets deleted, which means users cannot login to any organization using this client. The ‘allowedOrgs’ will be ignored during client_credentials flow.
The allowed general, organization and service scopes of access.
Timestamp, measured in number of seconds since 1/1/1970 UTC, indicating when the organization OAuth Application was created.
The username (email) of the user who created the organization OAuth Application.
The description of the organization OAuth Application (client).
The organization OAuth Application display name.
When set to true, the flag mandates the use of PKCE when doing an authorization_code flow (i.e., the request will fail if PKCE is not used).
The OAuth grant types. Customer organizations support the following grant types: authorization_code, refresh_token, and client_credentials. Service organizations additionally support the following grant types: audience_exchange, client_delegate, and context_switch.
Temporary flag used to request de-dup of domain name in ID token by setting value to ‘false’.
The unique identifier of the OAuth Application (client).
If the organization OAuth App can be changed
Timestamp, measured in number of seconds since 1/1/1970 UTC, indicating when the organization OAuth Application was last updated.
The username (email) of the user who updated the organization OAuth Application.
Maximum number of Additional attribute masks in ID token. Refer to GAZ docs.
Limit the number of text characters that will be put in the access token. If the resulting access token would exceed this value, an overflow behavior will be triggered. If overflow is triggered, the returned access token will contain a claim ‘ovc’ that lists the claims which have overflowed. For example ‘ovc’ : [‘perms’, ‘authorization_details’]. When overflow is triggered, the token will also contain an ‘ovl’ claim containing a URL which can be can be used to expand the access token and return the claims as JSON. For example ‘ovl’: ‘https://gaz.csp-vidm-prod.com/api/check_access_token' When ‘maxCharactersInAccessToken’ is not set (the default), a system defined value will be used. Currently this value is 3415 characters, or about 5KB. The purpose of this behavior is to help ensure that the request headers containing the JWT access token do not become arbitrarily large. Your system must be able to handle a token that contains ‘ovc’ and ‘ovl’ claims.
The maximum number of groups allowed in the ID token.
Unique identifier (GUID) of the organization.
When set to ’true’, the client is not allowed to rotate its own secret. Client rotation will be enabled for organization owner/service owner only using client rotation management APIs. By default, client is enabled to self-rotate its secret.
Post logout redirect URIs, can be used by a service as a custom redirect destination after logout. For e.g., the service login/home page. Relevant only for the authorization_code grant type.
Mark the client as a public client. Can only be specified at creation time (publicClient cannot be updated).
Public clients:
Cannot have a secret specified (the secret will implicitly be set as an empty string).
Cannot use the ‘client_credentials’ flow.
Cannot update or rotate their secret.
MUST use PKCE when doing an authorization_code flow.
The organization OAuth Application redirect URIs.
The organization OAuth Application refresh token time to live in seconds.
The secret rotation expiration in seconds. The old OAuth Application secret will expire after it. If not specified, the default expiration time is 48 hours.
The unique identifier of the Service
Temporary flag used to request issuer URL to be set to CSP URL so that it is OIDC compliant (Default false, but will be changed to true after deprecation cycle).
Errors
Invalid request body
The user is not authorized to use the API
The user is forbidden to use the API
The requested resource could not be found
The request could not be processed due to a conflict
The user has sent too many requests
An unexpected error has occurred while processing the request
Code Samples
cURL Command
Vendor Extensions
x-required-roles: org_admin,org_owner,developer
x-slo-tier: TIER2
