CreateOAuth2ServerClient

Synopsis

[Actions]
CreateOAuth2ServerClient:Name=Name,ClientId=ClientId,ClientType=ClientType[,Additional Properties]

Where:

• Name is the name of this client

• ClientId is the new unique ID for this client.

• ClientType is public, confidential, or resource.

Description

CreateOAuth2ServerClient defines a client description in the security database for when InterSystems IRIS® has been set up as an authorization server (see Creating the Authorization Server Configuration). InterSystems IRIS creates the defined client description when processing the [Actions] section during a configuration merge. During the merge, InterSystems IRIS runs OAuth2.Server.Client.Create()Opens in a new tab to create the client description defined by CreateOAuth2ServerClient.

The required properties for CreateOAuth2ServerClient are Name, ClientId, and ClientType, all other properties are optional. You can specify any possible client description properties in the CreateOAuth2ServerClient definition, including PublicJWKSExpires. 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 CreateOAuth2ServerClient by editing the merge file in a text editor (as described in Editing the Active CPF).

See Creating a Client Description for more information on client descriptions.