Attribute

RedirectURI (o2ru)

Purpose

Specifies the endpoint to which the client is returned after authenticating with a third-party service when OAuth 2.0 authentication is enabled (AuthenticationMethod=OAuth2).

For some authentication flows, the REST service will redirect you to a third-party service for authentication. Once your credentials have been validated, the third-party service returns the client to an endpoint in the REST service to continue the session. The endpoint used by the third-party service is provided by the client and specified using the Redirect URI option.

Valid Values

String

where:

String

is the endpoint used to retrieve OAuth 2.0 authorization codes. For example, https://example.com/countries/.

Notes

  • The redirect endpoint is often registered with the authentication service to provide improved security. Registering the endpoint prevents your valid authentication credentials being redirected to a malicious site; therefore, reducing the risk of sharing your access token and other sensitive information with unauthorized parties.

  • See "OAuth 2.0 authentication" for examples and more information.

Default Value

No default value