OAuth ProviderBrandDetails Object

Contains branding and other information for an OAuth Provider.

This object is used by the following operations:

The properties included in the ProviderBrandDetails object are listed below.

Property Type Description
LogoURL anyURI The URL for the OAuth provider's logo.
Footer string Information for the footer of the branding page.
AuthorizationServerURL string

The authorization server URL for the OAuth provider.

This URL must be accessible to all the apps and end-users that want to communicate to your APIs using the OAuth protocol. The Authorization Endpoint and Token Endpoint for OAuth 1.0a and OAuth 2.0 will use different paths, according to the specific OAuth version. Firewalls and DNS servers must be set up for this URL so that end-users and apps can access the URL. The protocol/host/path should resolve to one or more containers with either the OAuth Provider or OAuth Provider Agent feature installed.

AdditionalVirtualHosts string If your OAuth provider has one or more additional virtual hosts, as well as the hostname in the Authorization Server URL, enter the additional hostnames, separated by commas. The authorization server must be able to resolve these virtual hosts to an IP address.
SSLRequired boolean Indicates whether the OAuth provider requires SSL.
GrantProvisioningUIURL string

The URL for your OAuth provider’s grant provisioning UI, if the provider has its own UI. If you want your OAuth provider to use the grant provisioning UI provided by the platform, leave blank.

In request messages: to send the grant as a parameter in the URL, include the {GrantID} placeholder in the URL.

Back to top

Related Topics