com.laserfiche.api.client.oauth

Interface TokenClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TokenClientImpl

public interface TokenClient
extends AutoCloseable

The Laserfiche Cloud token route API client.

Method Summary

Modifier and Type	Method and Description
void	close() An implementation of AutoCloseable that does not throw any checked exceptions.
GetAccessTokenResponse	getAccessTokenFromServicePrincipal(String servicePrincipalKey, AccessKey accessKey) Gets an OAuth access token given a Laserfiche Cloud service principal key and an OAuth service application access key.
GetAccessTokenResponse	getAccessTokenFromServicePrincipal(String servicePrincipalKey, AccessKey accessKey, String scope) Gets an OAuth access token given a Laserfiche Cloud service principal key and an OAuth service application access key.

Method Detail

getAccessTokenFromServicePrincipal

GetAccessTokenResponse getAccessTokenFromServicePrincipal(String servicePrincipalKey,
                                                          AccessKey accessKey)

Gets an OAuth access token given a Laserfiche Cloud service principal key and an OAuth service application access key. These values can be exported from the Laserfiche Developer Console. This is the client credentials flow that applies to service applications.

Parameters:

servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.

accessKey - The access key exported from the Laserfiche Developer Console.

Returns:

A response that contains an access token

getAccessTokenFromServicePrincipal

GetAccessTokenResponse getAccessTokenFromServicePrincipal(String servicePrincipalKey,
                                                          AccessKey accessKey,
                                                          String scope)

Gets an OAuth access token given a Laserfiche Cloud service principal key and an OAuth service application access key. These values can be exported from the Laserfiche Developer Console. This is the client credentials flow that applies to service applications.

Parameters:

servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.

accessKey - The access key exported from the Laserfiche Developer Console.

scope - The requested space-delimited scopes for the access token.

Returns:

A response that contains an access token

close

void close()

An implementation of AutoCloseable that does not throw any checked exceptions.

Specified by:

close in interface AutoCloseable