Skip to content

RestClient.Authenticate

Overview

bool RestClient.Authenticate ( [service], [scope], [identity] )
Authenticates the client from specified service with scope and user and returns the authentication result.

Arguments

String service Name of service to authenticate. Can be empty.

String scope Scope of authentication context.

Identity | String identity Identity to impersonate

Remarks

  • If service argument empty, client is authenticated with HTTP basic credentials from domain settings.
  • Scope argument is based on service parameter and may change to following request's security context. 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.
  • Authentication result can be queried with RestClient.IsAuthenticated property.

Examples

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');

if ( client.Authenticate('Google',scopes, $Initiator) ) {

  var userInfo = client.ExecuteJson();

}

See Also