Overview
This service provides a SOAP alternative to the RESTful oauth2revoketoken service, and is used to revoke an OAuth 2 Token that was previously 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 | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data | |
|---|---|---|---|---|---|---|
Int32 | No | Click here for more information | ||||
String | Yes | Click here for more informationNo | 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 | ||
Token | String | Yes | A valid refresh token that designates a client app connection needing a refresh | E2BgYJjLoNrEY50z-7gMN1evukfd3EWpZcn5RQW6xemGeYelfl_aetMDAA | ||
TokenType | String | No | refresh_token | The string "refresh_token" may be supplied, and will be assumed if omitted. No other value is currently permitted. | refresh_token |
Request Usage Example(s)
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsRevokeOauth2RefreshToken>
<pws:serviceRequest>
<req:ClientIdentifier>24748faf-e239-d132-167a-6e4d3e1bd0fb</req:ClientIdentifier>
<req:ClientSecret>r6tuVhR3ol1BFFVfy3Oe-J8VoH0KpkgLVqAMi-IIgvd_Lr613IEYcXhKAea8eLtQKSIgQ4jHIKhCKQcwriUtgB</req:ClientSecret>
<req:Token>E2BgYJjLoNrEY50z-7gMN1evukfd3EWpZcn5RQW6xemGeYelfl_aetMDAA</req:Token>
</pws:serviceRequest>
</pws:PwsRevokeOauth2RefreshToken>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information | ||
RequestStatus | Click here for more information | ||
DateTime | Click here for more information | ||
RedirectUrl | String |
...
If this is set, this | https://secure2.projectorpsa.com |
PwsRevokeOauth2RefreshToken - Common Errors and Warnings
...
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 50629 | OauthUnsupportedGrantType | Unsupported OAuth2 Grant Type "{GrantType}". |
| 50630 | OauthInvalidClient | Invalid Oauth2 Client. |
| 50631 | OauthInvalidGrant | Invalid Grant for Oauth2 Token: "{InvalidReason}". |
| 50632 | OauthInvalidRequest | Invalid OAuth2 Request in Context "{Context}". Null or missing parameters "{Missing}". Improper parameters "{Improper}". |
| 50635 | OauthUnsupportedTokenType | Unsupported OAuth2 Token Type "{TokenType}". |