Skip to main content

CreateOAuth2Resource

Create a new OAuth resource server.

Synopsis

[Actions]
CreateOAuth2Resource:Name=Name[,Authenticator=Authenticator,ServerDefinition=ServerDefinition,Audiences=Audiences,AdditionalProperteis]

Where:

  • Name is the name of the new resource server.

  • Authenticator is a %DynamicObjectOpens in a new tab or a JSON string. What is passed to Authenticator is saved in the Authenticator property of the OAuth2.ResourceServerOpens in a new tab class. The default is:

    "{"Implementation":"%OAuth2.ResourceServer.SimpleAuthenticator"}"
    
  • ServerDefinition is the server definition’s IssuerEndpoint string. The ServerDefintion object must already exist before using it in this action.

  • Audiences is a comma-delimited string. What is passed to Audiences is saved in the Audiences property of the OAuth2.ResourceServerOpens in a new tab class.

Description

CreateOAuth2Resource creates an OAuth resource server. InterSystems IRIS® creates the defined resource server when processing the [Actions] section during a configuration merge. During the merge, InterSystems IRIS runs OAuth2.ResourceServer.Create()Opens in a new tab to create the resource server defined by CreateOAuth2Resource.

Only the Name property is required, 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 CreateOAuth2Resource by editing the merge file in a text editor (as described in Editing the Active CPF).

See Using an InterSytems IRIS Web Application as an OAuth 2.0 Resource Server for more information.

FeedbackOpens in a new tab