Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [OAuth2] >  [ServerDefinition]
Private  Storage   

persistent class OAuth2.ServerDefinition extends %Persistent

OAuth2. ServerDefinition is a persistent class which defines an authorization server which is available to this InterSystems IRIS instance for OAuth 2.0 client definition. The authorization server definition may be used by multiple client application definitions.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
14 25 1


Summary

Properties
AuthorizationEndpoint Clients InitialAccessToken IntrospectionEndpoint
IssuerEndpoint Metadata RevocationEndpoint SSLConfiguration
ServerCredentials TokenEndpoint UserinfoEndpoint

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject ClientCount
DeleteId Open OpenByIssuer SetPublicJWKS
UpdateJWKS


Properties

• property AuthorizationEndpoint as %OAuth2.uri;
**** Moved to OAuth2.Server.Metadata when dynamic client support introduced
The endpoint URL to be used for to request an authorization code from the authorization server.
Required if ClientType is public or confidential.
Based on Authorization Server documentation.
• relationship Clients as OAuth2.Client [ Inverse = ServerDefinition,Cardinality = many ];
The clients that use this server defintion.
• property InitialAccessToken as %String(MAXLEN=2048);
The optional initial registration access token which may be specified out of band and is used as a bearer token to authorize the synamic client registartion request.
• property IntrospectionEndpoint as %OAuth2.uri;
**** Moved to OAuth2.Server.Metadata when dynamic client support introduced
The endpoint URL to be used for to make a RFC 7662 based token introspection request using the client_id and client_secret for authorization.
• property IssuerEndpoint as %String(COLLATION="EXACT",MAXLEN=1024) [ Required ];
The endpoint URL to be used to identify the authorization server.
Required for all ClientTypes.
• property Metadata as OAuth2.Server.Metadata;
The meta data which describes this authorization server,
• property RevocationEndpoint as %OAuth2.uri;
**** Moved to OAuth2.Server.Metadata when dynamic client support introduced
The endpoint URL to be used for to make a RFC 7009 based token revocation request using the client_id and client_secret for authorization.
• property SSLConfiguration as %String(MAXLEN=64,MINLEN=1);
The name of the activated TLS/SSL configuration to use for authorization server Discovery requests.
Chosen by user during configuration.
• property ServerCredentials as %String;
ServerCredentials is the alias of the %SYS.X509Credentials object which contains the server's certificate.
• property TokenEndpoint as %OAuth2.uri;
**** Moved to OAuth2.Server.Metadata when dynamic client support introduced
The endpoint URL to be used for to request an access token from the authorization server.
Required for all ClientTypes.
Based on Authorization Server documentation.
• property UserinfoEndpoint as %OAuth2.uri;
**** Moved to OAuth2.Server.Metadata when dynamic client support introduced
The endpoint URL to be used for to make a userinfo request using an access token from the authorization server for authorization

Methods

• method ClientCount() as %Integer
Get count of clients for this server definition
• classmethod DeleteId(id As %String) as %Status
Delete this server definition.
• classmethod Open(serverDefinitionId As %String, Output sc As %Status) as OAuth2.ServerDefinition
Open the OAuth2.ServerDefinition instance.
• classmethod OpenByIssuer(issuerEndpoint As %String, Output sc As %Status) as OAuth2.ServerDefinition
Open an OAuth2.ServerDefinition instance based on the IssuerEndpoint property
• method SetPublicJWKS(publicJWKS As %String = "", jwksUri As %String = "") as %Status
Manually set the authorization server supplied public JWKS and optionally jwks_uri.
• method UpdateJWKS(Output sc As %Status) as %Boolean
Get and save a new public JWKS for the authorization server if the JWKS was specified using jwks_uri metadata. Return true if a new JWKS was obtained

Queries

• query List()
SQL Query :
SELECT ID, IssuerEndpoint,
( SELECT COUNT(*) FROM Client WHERE ServerDefinition->ID = sd.ID ) AS ClientCount
FROM ServerDefinition as sd
ORDER BY IssuerEndpoint
List authorization servers available to client applications for SMP page


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.