Skip to content

Latest commit

 

History

History
240 lines (161 loc) · 7.1 KB

TokensApi.md

File metadata and controls

240 lines (161 loc) · 7.1 KB
Raw

affinidi_tdk_iam_client.api.TokensApi

Load the API package

import 'package:affinidi_tdk_iam_client/api.dart';

All URIs are relative to https://apse1.api.affinidi.io/iam

Method HTTP request Description
createToken POST /v1/tokens
deleteToken DELETE /v1/tokens/{tokenId}
getToken GET /v1/tokens/{tokenId}
listToken GET /v1/tokens
updateToken PATCH /v1/tokens/{tokenId}

createToken

TokenDto createToken(createTokenInput)

Example

import 'package:affinidi_tdk_iam_client/api.dart';
// TODO Configure API key authorization: UserTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = TokensApi();
final createTokenInput = CreateTokenInput(); // CreateTokenInput | CreateToken

try {
    final result = api_instance.createToken(createTokenInput);
    print(result);
} catch (e) {
    print('Exception when calling TokensApi->createToken: $e\n');
}

Parameters

Name Type Description Notes
createTokenInput CreateTokenInput CreateToken

Return type

TokenDto

Authorization

UserTokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteToken

deleteToken(tokenId)

Example

import 'package:affinidi_tdk_iam_client/api.dart';
// TODO Configure API key authorization: UserTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = TokensApi();
final tokenId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |

try {
    api_instance.deleteToken(tokenId);
} catch (e) {
    print('Exception when calling TokensApi->deleteToken: $e\n');
}

Parameters

Name Type Description Notes
tokenId String

Return type

void (empty response body)

Authorization

UserTokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getToken

TokenDto getToken(tokenId)

Example

import 'package:affinidi_tdk_iam_client/api.dart';
// TODO Configure API key authorization: UserTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = TokensApi();
final tokenId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |

try {
    final result = api_instance.getToken(tokenId);
    print(result);
} catch (e) {
    print('Exception when calling TokensApi->getToken: $e\n');
}

Parameters

Name Type Description Notes
tokenId String

Return type

TokenDto

Authorization

UserTokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listToken

TokenList listToken()

Example

import 'package:affinidi_tdk_iam_client/api.dart';
// TODO Configure API key authorization: UserTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = TokensApi();

try {
    final result = api_instance.listToken();
    print(result);
} catch (e) {
    print('Exception when calling TokensApi->listToken: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

TokenList

Authorization

UserTokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateToken

TokenDto updateToken(tokenId, updateTokenInput)

Example

import 'package:affinidi_tdk_iam_client/api.dart';
// TODO Configure API key authorization: UserTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('UserTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = TokensApi();
final tokenId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final updateTokenInput = UpdateTokenInput(); // UpdateTokenInput | UpdateToken

try {
    final result = api_instance.updateToken(tokenId, updateTokenInput);
    print(result);
} catch (e) {
    print('Exception when calling TokensApi->updateToken: $e\n');
}

Parameters

Name Type Description Notes
tokenId String
updateTokenInput UpdateTokenInput UpdateToken

Return type

TokenDto

Authorization

UserTokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]