Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This service provides a SOAP alternative to the RESTful oauth2token  service, and is used to acquire an OAuth 2 Token that can be used by an OAuth 2 Authenticated User of a Client App for access to Projector services.  Note that this service should not be provided with a SessionTicket on invocation.  Note also that if the response has a non-null value for RedirectUrl , the service was invoked on the incorrect server and must be re-invoked on the server specified in RedirectUrl .

Request Format


Panel
titlePwsAcquireOauth2Token Request
  • PwsAcquireOauth2Token

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information


SessionTicket

String

No


Should be omitted or set to null.


ClientIdentifier

String

Yes


Guid string that identifies the client app requesting a token

24748faf-e239-d132-167a-6e4d3e1bd0fb

ClientSecret

String

Yes


Secret string that client app uses to prove itself

r6tuVhR3ol1BFFVfy3Oe-J8VoH0KpkgLVqAMi-IIgvd_Lr613IEYcXhKAea8eLtQKSIgQ4jHIKhCKQcwriUtgB

Code

String

When GrantType="code"


The short-lived authentication code that was provided on the successful redirect of the oauth2authorize  request.  Must be supplied if GrantType="code" and may not be supplied for any other GrantType.

E2BgYJjLoNrEY50z-8hLMXevukfd3EWpZcn5RQW6xemGeYelfl_aetMDAA

CodeVerifier

String

No


Code Verifier generated by the client app and for which a code challenge was previously sent as part of the oauth2authorize  request that was implementing PKCE.  May only be supplied if GrantType="code", and must be supplied if a code challenge was part of the authorization request that generated the code.

swubMxS7yR-SYjlEwuu5gaS8~bvgL-ngbpZiYFLR_4Vf~u388c.qimhmm6kVc3h3h~TSmhDj02AIPeGcI_Y

GrantType

String

Yes


Currently must be either "code" for an initial grant, or "refresh_token" for a token refresh.


RedirectUri

String

When GrantType="code"


Must be identical to the redirect_uri  that was supplied as part of the oauth2authorize  request.

https://my.app.com/redirect-handler

RefreshToken

String

When GrantType="refresh_token"


A valid refresh token that designates a client app connection needing a refresh

E2BgYJjLoNrEY50z-7gMN1evukfd3EWpZcn5RQW6xemGeYelfl_aetMDAA

...