OAuth LoginResponse Object

Contains information about the response to an OAuth login request.

This object is used by the following operations:

The properties included in the LoginResponse object are listed below.

Property Type Description
DomainName string Optional. The domain name for the user identity. If the user is the resource owner, it's the resource owner authentication domain. If the user is a site user, it could be the platform; or it could be any other domain. It's the domain the user authenticated with.
UserName string Optional. The user's username on the login domain.
InstructionType string

Used only if the login was not successful, to indicate what action is needed to complete the login. Possible values:

  • authentication_challenge (same as NeedCredentials in the platform's Login API, LoginResponse object)
  • redirect (same as NeedRedirect in the platform's Login API, LoginResponse object)
RedirectURL string Optional.The redirect URL, if InstructionType value is redirect.
IdentityAttributesNeeded[ ] string Optional. Used if InstructionType value is authentication_challenge. Can be multiple.
SecretAttributesNeeded[ ] string Optional. Used if InstructionType value is authentication_challenge. Can be multiple.

Back to top

Related Topics