affinidi_tdk_consumer_iam_client 1.2.0
affinidi_tdk_consumer_iam_client: ^1.2.0 copied to clipboard
Affinidi TDK dart client for Affinidi CONSUMER IAM
affinidi_tdk_consumer_iam_client #
Affinidi TDK dart client for Affinidi CONSUMER IAM
Requirements #
- Dart 3.6.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
affinidi_tdk_consumer_iam_client: ^1.0.0
Github #
This Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
affinidi_tdk_consumer_iam_client:
git:
url: https://github.com/affinidi/affinidi-tdk.git
ref: main
path: clients/dart/consumer_iam_client
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
affinidi_tdk_consumer_iam_client:
path: /path/to/affinidi_tdk_consumer_iam_client
Install dependencies #
dart pub get
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:affinidi_tdk_consumer_iam_client/affinidi_tdk_consumer_iam_client.dart';
final api = AffinidiTdkConsumerIamClient().getAuthzApi();
final String granteeDid = granteeDid_example; // String |
try {
api.deleteAccessVfs(granteeDid);
} catch on DioException (e) {
print("Exception when calling AuthzApi->deleteAccessVfs: $e\n");
}
Documentation for API Endpoints #
All URIs are relative to https://apse1.api.affinidi.io/cid
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthzApi | deleteAccessVfs | DELETE /v1/authz/vfs/access/{granteeDid} | delete access of granteeDid |
| AuthzApi | getAccessVfs | GET /v1/authz/vfs/access/{granteeDid} | Get permissions to the virtual file system for a subject |
| AuthzApi | grantAccessVfs | POST /v1/authz/vfs/access/{granteeDid} | Grant access to the virtual file system |
| AuthzApi | updateAccessVfs | PUT /v1/authz/vfs/access/{granteeDid} | Update access of granteeDid |
| ConsumerAuthApi | consumerAuthTokenEndpoint | POST /v1/consumer/oauth2/token | The Consumer OAuth 2.0 Token Endpoint |
| WellKnownApi | getWellKnownJwks | GET /.well-known/jwks.json |
Documentation For Models #
- ConsumerAuthTokenEndpointInput
- ConsumerAuthTokenEndpointOutput
- CorsConsumerAuthTokenEndpointOK
- GetAccessOutput
- GrantAccessInput
- GrantAccessOutput
- InvalidDIDError
- InvalidJwtTokenError
- InvalidJwtTokenErrorDetailsInner
- InvalidParameterError
- JsonWebKeyDto
- JsonWebKeySetDto
- Permission
- RightsEnum
- UnauthorizedError
- UnexpectedError
- UpdateAccessInput
- UpdateAccessOutput
Documentation For Authorization #
Authentication schemes defined for the API:
ConsumerTokenAuth #
- Type: API key
- API key parameter name: authorization
- Location: HTTP header