Class OAuthService

• Defined in File OAuthService.cs

Inheritance Relationships

Base Type

• public xbe.sdk.ServiceBase (Class ServiceBase)

Class Documentation

class xbe.sdk.Services.OAuthService : xbe.sdk.ServiceBase

The OAuthService

provides an API for implementing OAuth 2.0 compatible single-sign on between an XBE cluster and

third party applications.

Public Functions

async Task<string> Authorize (string clientID, string responseType, string redirectURI, string state, params string[] scope)

Requests an authorization token for the OAuth 2.0 application with the specified parameters. This function

returns the redirect URL containing the authorization token.Upon return, the implementing client should

automatically redirect the browser to the returned URL to complete the process.

async Task<string> GetAuthorizationURL (string clientID, string responseType, string redirectURI, string state, params string[] scope)

Retrieves the authorization URL for the OAuth 2.0 application with the specified parameters.

async Task<Object> GetAccessToken (string code, string clientId, string clientSecret, string redirectURI)

Requests an access token for the specified OAuth 2.0 authorization token and application configuration.

Public Static Attributes

readonly string[] SCOPES = new[] { "email", "openid", "phone", "profile" }

The list of supported OAuth 2.0 scopes.

readonly string[] RESPONSE_TYPES = new string[] { "code", "id_token" }

The list of supported response types.