CreateOAuth2Server
Synopsis
[Actions]
CreateOAuth2Server:SupportedScopes=SupportedScopes,IssuerEndpoint=IssuerEndpiont,CustomizationRoles=CustomizationRoles,CustomizaitonNamespace=CustomizationNamespace,SSLConfiguration=SSLConfigName[,Additional Properties]
Where:
-
SupportedScopes is a JSON string of the scopes and description of the scopes. For example:
{"scope1":"description1","scope2":"description2"} -
IssuerEndpoint is the endpoint for this authorization server, for example https:localhost:80/YourIssuerEndpoint.
-
CustomizationRoles is a comma-separated list of roles.
-
CustomizationNamespace is the namespace where the customization code will run.
-
SSLConfigName is the name of the activated TLS/SSL configuration to use loading a request object.
Description
CreateOAuth2Server defines an authorization server configuration in the security database. InterSystems IRIS® creates the defined authorization server configuration when processing the [Actions] section during a configuration merge. During the merge, InterSystems IRIS runs OAuth2.Server.Configuration.Create()Opens in a new tab to create the authorization server defined by CreateOAuth2Server.
The required properties for CreateOAuth2Server are SupportedScopes, IssuerEndpoint, CustomizationRoles, CustomizationNamespace, and SSLConfiguration, all other OAuth2.Server.Configuration.Create()Opens in a new tab properties are optional. The complete list of properties is available in the class reference.
The SigningAlgorithm, KeyAlgorithm, and EncryptionAlgorithm properties cannot explicitly be set to null ("") using CreateOAuth2Server. If you try to set the preceding properties to null you will receive an error.
Changing this Operation
This operation is designed to be used during a configuration merge. You can change CreateOAuth2Server by editing the merge file in a text editor (as described in Editing the Active CPF).
See Creating the Authorization Server Configuration for more information on authorization server configurations.
