OAuthAPI variables and records
The OAuthAPI library provides public variables and records.
RegisterRequestType
The OAuthAPI library defines the
OAuthAPI.RegisterRequestType
as a
record:PUBLIC
TYPE RegisterRequestType RECORD
redirect_uris DYNAMIC ARRAY OF STRING, # REQUIRED
response_types DYNAMIC ARRAY OF STRING, # OPTIONAL
grant_types DYNAMIC ARRAY OF STRING, # OPTIONAL
client_name STRING,
client_description STRING,
scope STRING # OPTIONAL
END RECORD
For more information on these parameters, see the Authorization Request section of the OAuth specification.
RegisterResponseType
The OAuthAPI library defines the
OAuthAPI.RegisterResponseType
as a
record:PUBLIC
TYPE RegisterResponseType RECORD
client_id STRING, # REQUIRED
client_secret STRING, # OPTIONAL
grant_types DYNAMIC ARRAY OF STRING, # OPTIONAL
redirect_uris DYNAMIC ARRAY OF STRING, # OPTIONAL
client_name STRING,
client_description STRING,
scope STRING # OPTIONAL
END RECORD
For more information on these parameters, see the Authorization Response section of the OAuth specification.
OpenIDMetadataType
The OAuthApp library defines the
OAuthApp.OpenIDMetadataType
as a public
record:PUBLIC TYPE OpenIDMetadataType RECORD
issuer STRING, # REQUIRED
authorization_endpoint STRING, # REQUIRED
token_endpoint STRING, # REQUIRED
userinfo_endpoint STRING, # RECOMMENDED
jwks_uri STRING, # REQUIRED
registration_endpoint STRING, # RECOMMENDED
scopes_supported DYNAMIC ARRAY OF STRING, # RECOMMENDED
response_types_supported DYNAMIC ARRAY OF STRING, # REQUIRED
response_modes_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
grant_types_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
acr_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
subject_types_supported DYNAMIC ARRAY OF STRING, # REQUIRED
id_token_signing_alg_values_supported DYNAMIC ARRAY OF STRING, # REQUIRED
id_token_encryption_alg_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
id_token_encryption_enc_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
userinfo_signing_alg_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
userinfo_encryption_alg_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
userinfo_encryption_enc_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
request_object_signing_alg_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
request_object_encryption_alg_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
request_object_encryption_enc_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
token_endpoint_auth_methods_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
token_endpoint_auth_signing_alg_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
display_values_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
claim_types_supported DYNAMIC ARRAY OF STRING, # OPTIONAL
claims_supported DYNAMIC ARRAY OF STRING, # RECOMMENDED
service_documentation STRING, # OPTIONAL
claims_locales_supported STRING, # OPTIONAL
ui_locales_supported STRING, # OPTIONAL
claims_parameter_supported STRING, # OPTIONAL
request_parameter_supported STRING, # OPTIONAL
request_uri_parameter_supported STRING, # OPTIONAL
require_request_uri_registration STRING, # OPTIONAL
op_policy_uri STRING, # OPTIONAL
op_tos_uri STRING, # OPTIONAL
end_session_endpoint STRING # OPTIONAL
END RECORD
For
further details, refer to the OpenID Connect Core specification.