OrgOAuthAppRequest

The request body to create organization OAuth Application.


Properties

allowedScopes Required

The allowed general, organization and service scopes of access.


array of string
grantTypes Required

The OAuth grant types. Available grant types are: authorization_code, refresh_token, client_credentials and client_delegate.


string
displayName Required

The organization OAuth Application display name..
The value must be alphanumerical and can contain the following symbols -_.`‘:@&, and space. International characters are allowed.


string
description Required

The description of the organization OAuth Application (client).


integer as int32
accessTokenTTL Optional

The organization OAuth Application access token time to live in seconds.


array of string
allowedOrgs Optional

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.


boolean
allowOpenRedirectUris Optional

Allow client to use open redirections in non-production environments. If true, the redirectUris field must be null. If a client has been created with open redirect uris disabled, it cannot be updated to open redirect uris enabled.


boolean
forcePkce Optional

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).


array of string
additionalAttributeMasks Optional

Additional attribute masks. Refer to GAZ docs.


string as ^[A-Za-z0-9-_]+$
id Optional

The unique identifier of the OAuth Application (client).. Constraints:
1. Must contain at least 5 and at most 256 characters.
2. Allowed characters: A-Z a-z 0-9 _ -
3. Whitespaces are not allowed.


integer as int32
maxCharactersInAccessToken Optional

Limit the number of text characters that would be put in the access token. If the access token has more characters than the max number provided, an overflow link will be provided in the access token. A value of zero will be considered as unlimited. A value of less than zero will be treated the same as not setting any value. If overflow happens the access token will have a claim ‘ovc’ that lists the claims which have overflowed. For example ‘ovc’ : [‘perms’, ‘authorization_details’]. It will also have a ‘ovl’ claim which is the link that can be used to get the full access token as json. For example ‘ovl’: ‘https://gaz.csp-vidm-prod.com/api/check_access_token’ When ‘maxCharactersInAccessToken’ is not set (the default), the maxCharactersInAccessToken parameter will be in effect if it is set. If it is not set, there will be no limit on the number of permissions.


integer as int32
maxGroupsInIdToken Optional

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.


boolean
ownerOnlySecretRotation Optional

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.


array of string
postLogoutRedirectUris Optional

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.


boolean
publicClient Optional

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.


array of string
redirectUris Optional

The organization OAuth Application redirect URIs. Relevant only for authorization_code grant type. If allowOpenRedirectUris = true is set, this field must not be specified.


integer as int32
refreshTokenTTL Optional

The organization OAuth Application refresh token time to live in seconds.


string as (?=.{8,})(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#$%^&*()_+=\[\]-{|}',./:;<>?`~]).*
secret Optional

The organization OAuth Application secret


integer as int32
secretRotationExpirationInSeconds Optional

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.


string
serviceDefinitionId Optional

Service definition ID of the service using this authorization code webapp. Required in production for tracking purposes.

JSON Example

{
	"allowedScopes": {},
	"description": "string",
	"displayName": "string",
	"grantTypes": [
		"string"
	]
}

Feedback

Was this page helpful?