CreateOAuth2Client
Synopsis
[Actions]
CreateOAuth2Client:ApplicationName=ClientApplicationName,ClientType=ClientType,ServerDefinition=IssuerEndpoint,SSLConfiguration=SSLConfigName[,Additional Properties]
Where:
-
ClientApplicationName identifies the application configuration.
-
ClientType is public, confidential, or resource. If ClientType=resource, then the RedirectionEndpoint property is also required.
-
IssuerEndpoint is the IssuerEndpoint of the OAuth2.ServerDefinitionOpens in a new tab object which describes the authorization server.
-
SSLConfigName is the name of the activated TLS/SSL configuration to use for authorization server requests.
Description
CreateOAuth2Client defines a client configuration in the security database for when a server definition has already been set up. InterSystems IRIS® creates the defined client configuration when processing the [Actions] section during a configuration merge. During the merge, InterSystems IRIS runs OAuth2.Client.Create()Opens in a new tab to create the client configuration defined by CreateOAuth2Client.
The required properties for CreateOAuth2Client are ApplicationName, ClientType, ServerDefinition, and SSLConfiguration, all other properties are optional. The complete list of properties is available in the class reference.
Changing this Operation
This operation is designed to be used during a configuration merge. You can change CreateOAuth2Client by editing the merge file in a text editor (as described in Editing the Active CPF).
See Creating a Client Configuration for more information on client configurations.
