Versions Compared

Key

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

Overview

Authenticates the client from specified service with scope if not already authenticated and user and returns the client.

RestClient myRestClient.EnsureAuthenticated(service: string)

Authenticates the client from specified service with scope if not already authenticated and user and returns the client.

RestClient myRestClient.EnsureAuthenticated(service: string, scope: string)

Authenticates the client from specified service with scope if not already authenticated and user and returns the client.

RestClient myRestClient.EnsureAuthenticated(service: string, scope: string, identity: ( string | Identity ))

Arguments

string service
Name of service to authenticate.
string scope
Scope of authentication context.
( string | Identity ) identity
Identity to impersonate.

Remarks

Scope argument is based on service and may change. Please refer the service documentation.

Identity is Id number of identity or Identity instance.

This method tries to server-to-server authentication if configured on service, otherwise user consent must be previously given.

If authentication failed error is thrown, use in try-catch block to act upon.

Example

Code Block
languagets
var scopes = 'https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email';

var client = $Rest.Create('https://www.googleapis.com/oauth2/v2/userinfo');

var result = client.EnsureAuthenticated('Google',scopes, $Initiator).ExecuteJson();