Get Authorization URL

Description

This API is used to obtain a URL for the login providers authorization (login) form. The API is used in the OAuth login approach without using login provider's SDK (see Step 1 in Login Without Provider's SDK).

Method

public void Backendless.UserService.GetAuthorizationUrlLink( String authProviderCode, Dictionary<String, String> fieldsMappings, List<String> scope, AsyncCallback<String> callback )

public IList<String> Backendless.UserService.GetAuthorizationUrlLink( String authProviderCode, Dictionary<String, String> fieldsMappings, List<String> scope )

public async Task<IList<String>> Backendless.UserService.GetAuthorizationUrlLinkAsync( String authProviderCode, Dictionary<String, String> fieldsMappings, List<String> scope )

where:

Argument	Description
authProviderCode	Name of the login provider as displayed in Backendless Console - see the specific provider screen at Users > Login Providers. String value.
fieldsMappings	Optional parameter. A mapping of user properties between OAuth provider and Backendless. If the map object is not null, it should contain a mapping between the provider specific property names and the column names in the Users table. Consider the following mappings: "my_email" >> "email" "my_name" >> "name" The key identifies the provider's property name and the value is the name of the mapped property (column name) in Backendless. In the example above, "my_email" and "my_name" are the properties returned by the OAuth2 provider and the corresponding values will be respectively stored in the "email" and "name" columns in Backendless. Must be an object.
scope	Optional parameter. A collection of security scopes the client application is requesting the permissions for. String value.
callback	Optional parameter. A responder object containing success/failure methods which are called when the user is logged in or if an error occurs. If the operation is successful, the callback method provides the BackendlessUser argument representing the currently logged in user.

Return Value

The method returns an authorization URL. It should be used to open up the provider's login form.

The object in the response has the following structure:

{          
  "url": "authorization URL"  
}

Example

The example below retrieves the authorization URL for "facebook".

// Blocking operation
var link = Backendless.UserService.GetAuthorizationUrlLink("facebook", new Dictionary<string, string>(), new List<string>());


// Non-blocking operation
var link = await Backendless.UserService.GetAuthorizationUrlLinkAsync("facebook", new Dictionary<string, string>(), new List<string>()); 


//Non-blocking operation with callback

Backendless.UserService.GetAuthorizationUrlLink("facebook", new Dictionary<string, string>(), new List<string>(), new BackendlessAPI.Async.AsyncCallback<string>(
        response =>
        {
          // proccess link
        },
        fault =>
        {
          // server returned an error
        }));