CreateOAuth2ServerDefinition

Create a new OAuth server description.

Synopsis

[Actions]
CreateOAuth2ServerDefinition:IssuerEndpoint=IssuerEndpoint,SSLConfiguration=SSLConfigName,Metadata=MetadataProperties[,Additional Properties]

Where:

IssuerEndpoint is the endpoint URL used to identify the authorization server.
SSLConfigName is the name of the activated TLS/SSL configuration to use for authorization server discovery requests.
MetadataProperties is a JSON string of OAuth2.Server.MetadataOpens in a new tab properties and values. To set the authorization_endpoint and token_endpoint properties in the OAuth2.Server.MetadataOpens in a new tab class, they must be set in this JSON string. For example:
```
Metadata={"authorization_endpoint":"YourAuthEndpoint","token_endpoint":"YourTokenEndpoint"}
```

Description

CreateOAuth2ServerDefinition defines a server description in the security database. InterSystems IRIS® creates the defined server description when processing the [Actions] section during a configuration merge. During the merge, InterSystems IRIS runs OAuth2.ServerDefinition.Create()Opens in a new tab to create the server description defined by CreateOAuth2ServerDefinition.

The required properties for CreateOAuth2ServerDefinition are IssuerEndpoint, SSLConfiguration, and Metadata; you may also optionally specify the InitialAccessToken and ServerCredentials properties. 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 CreateOAuth2ServerDefinition by editing the merge file in a text editor (as described in Editing the Active CPF).

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

DeleteOAuth2ServerDefinition

ModifyOAuth2ServerClient