Auth Provider

Generate Authorisation Token to call Affinidi Services.

Install Dependency

Package: affinidi-tdk/affinidi-tdk-php

composer require affinidi-tdk/affinidi-tdk-php

Check the latest version on the Packagist repository or view the source on GitHub.

API Endpoints

URLs required to initiate integration with Affinidi TDK.

Token Endpoint

Endpoint to generate access token to call Affinidi Services with TDK.

https://apse1.auth.developer.affinidi.io/auth/oauth2/token

API Gateway URL

Base API URL of Affinidi Services.

https://apse1.api.affinidi.io

Classes and Methods

AuthProvider API

Used to generate Project Scoped Token required for calling Affinidi services (Clients).

When initiating the AuthProvider class, provide the Token information including the public/private key information to generate the Authorisation Token required.

AuthProvider (constructor)

Initialises AuthProvider with the Personal Access Token credentials required to generate authorisation tokens.

Parameters

projectId string Required
ID of the project for which to generate the token.
privateKey string Required
Private key string used to sign the token.
passphrase string Optional
Passphrase for the private key, if one is configured.
tokenId string Required
ID of the Personal Access Token (PAT).

Example

require_once 'vendor/autoload.php';
use AffinidiTdk\AuthProvider\AuthProvider;

$params = [
    'privateKey'  => '<PAT_PRIVATE_KEY_STRING>',
    'passphrase'  => '<PAT_KEY_PAIR_PASSPHRASE>',
    'tokenId'     => '<PAT_ID>',
    'projectId'   => '<PROJECT_ID>',
];

$authProvider = new AuthProvider($params);

// Fetch token directly
$projectScopedToken = $authProvider->fetchProjectScopedToken();

// Or use as a callback
$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

fetchProjectScopedToken

Returns the generated project-scoped token for calling Affinidi services.

No parameters required.

Example

require_once 'vendor/autoload.php';
use AffinidiTdk\AuthProvider\AuthProvider;

$authProvider = new AuthProvider([
    'privateKey'  => '<PAT_PRIVATE_KEY_STRING>',
    'passphrase'  => '<PAT_KEY_PAIR_PASSPHRASE>',
    'tokenId'     => '<PAT_ID>',
    'projectId'   => '<PROJECT_ID>',
]);

$projectScopedToken = $authProvider->fetchProjectScopedToken();

createIotaToken

Creates an Affinidi Iota Framework token to generate Iota Credentials for signing the request token.

Parameters

iotaConfigId string Required
ID of the Iota configuration.
did string Required
DID of the logged-in user, obtained from the ID token provided by Affinidi Login.
iotaSessionId string Optional
ID of the initialised Iota session.

Example

require_once 'vendor/autoload.php';
use AffinidiTdk\AuthProvider\AuthProvider;

$authProvider = new AuthProvider([
    'privateKey'  => '<PAT_PRIVATE_KEY_STRING>',
    'passphrase'  => '<PAT_KEY_PAIR_PASSPHRASE>',
    'tokenId'     => '<PAT_ID>',
    'projectId'   => '<PROJECT_ID>',
]);

$iotaToken = $authProvider->createIotaToken('<IOTA_CONFIGURATION_ID>', '<LOGGED_IN_USER_DID>');