affinidi_tdk_iam_client 1.14.0 
affinidi_tdk_iam_client: ^1.14.0 copied to clipboard
Published 3 months ago • 
affinidi.com
Affinidi TDK dart client for Affinidi IAM
affinidi_tdk_iam_client (EXPERIMENTAL) #
Affinidi TDK dart client for Affinidi IAM
Requirements #
- Dart 2.15.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_iam_client: ^1.0.0
Github #
This Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
affinidi_tdk_iam_client:
git:
url: https://github.com/affinidi/affinidi-tdk.git
ref: main
path: clients/dart/iam_client
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
affinidi_tdk_iam_client:
path: /path/to/affinidi_tdk_iam_client
Install dependencies #
dart pub get
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:affinidi_tdk_iam_client/affinidi_tdk_iam_client.dart';
final api = AffinidiTdkIamClient().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/iam
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthzApi | deleteAccessVfs | DELETE /v1/authz/vfs/access/{granteeDid} | delete access of granteeDid |
| AuthzApi | grantAccessVfs | POST /v1/authz/vfs/access | 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 |
| DefaultApi | v1AuthProxyDelete | DELETE /v1/auth/{proxy+} | |
| DefaultApi | v1AuthProxyGet | GET /v1/auth/{proxy+} | |
| DefaultApi | v1AuthProxyPatch | PATCH /v1/auth/{proxy+} | |
| DefaultApi | v1AuthProxyPost | POST /v1/auth/{proxy+} | |
| DefaultApi | v1AuthProxyPut | PUT /v1/auth/{proxy+} | |
| DefaultApi | v1IdpProxyDelete | DELETE /v1/idp/{proxy+} | |
| DefaultApi | v1IdpProxyGet | GET /v1/idp/{proxy+} | |
| DefaultApi | v1IdpProxyPatch | PATCH /v1/idp/{proxy+} | |
| DefaultApi | v1IdpProxyPost | POST /v1/idp/{proxy+} | |
| DefaultApi | v1IdpProxyPut | PUT /v1/idp/{proxy+} | |
| PoliciesApi | getPolicies | GET /v1/policies/principals/{principalId} | |
| PoliciesApi | updatePolicies | PUT /v1/policies/principals/{principalId} | |
| ProjectsApi | addPrincipalToProject | POST /v1/projects/principals | |
| ProjectsApi | createProject | POST /v1/projects | |
| ProjectsApi | deletePrincipalFromProject | DELETE /v1/projects/principals/{principalId} | |
| ProjectsApi | listPrincipalsOfProject | GET /v1/projects/principals | |
| ProjectsApi | listProject | GET /v1/projects | |
| ProjectsApi | updateProject | PATCH /v1/projects/{projectId} | |
| StsApi | createProjectScopedToken | POST /v1/sts/create-project-scoped-token | |
| StsApi | whoami | GET /v1/sts/whoami | |
| TokensApi | createToken | POST /v1/tokens | |
| TokensApi | deleteToken | DELETE /v1/tokens/{tokenId} | |
| TokensApi | getToken | GET /v1/tokens/{tokenId} | |
| TokensApi | listProjectsOfToken | GET /v1/tokens/{tokenId}/projects | |
| TokensApi | listToken | GET /v1/tokens | |
| TokensApi | updateToken | PATCH /v1/tokens/{tokenId} | |
| WellKnownApi | getWellKnownDid | GET /.well-known/did.json | |
| WellKnownApi | getWellKnownJwks | GET /.well-known/jwks.json |
Documentation For Models #
- ActionForbiddenError
- AddUserToProjectInput
- ConsumerAuthTokenEndpointInput
- ConsumerAuthTokenEndpointOutput
- CorsConsumerAuthTokenEndpointOK
- CorsGrantAccessVfsOK
- CorsUpdateAccessVfsOK
- CreateProjectInput
- CreateProjectScopedTokenInput
- CreateProjectScopedTokenOutput
- CreateTokenInput
- DeleteAccessOutput
- GrantAccessInput
- GrantAccessOutput
- InvalidDIDError
- InvalidJwtTokenError
- InvalidParameterError
- JsonWebKeyDto
- JsonWebKeySetDto
- NotFoundError
- PolicyDto
- PolicyStatementDto
- PrincipalCannotBeDeletedError
- PrincipalDoesNotBelongToProjectError
- ProjectDto
- ProjectList
- ProjectWithPolicyDto
- ProjectWithPolicyList
- PublicKeyCannotBeResolvedFromDidError
- RightsEnum
- ServiceErrorResponse
- ServiceErrorResponseDetailsInner
- TokenDto
- TokenList
- TokenPrivateKeyAuthenticationMethodDto
- TokenPrivateKeyAuthenticationMethodDtoPublicKeyInfo
- TokenPrivateKeyAuthenticationMethodDtoPublicKeyInfoOneOf
- TokenPrivateKeyAuthenticationMethodDtoPublicKeyInfoOneOf1
- TypedPrincipalId
- UnauthorizedError
- UnexpectedError
- UpdateAccessInput
- UpdateAccessOutput
- UpdateProjectInput
- UpdateTokenInput
- UpdateTokenPrivateKeyAuthenticationMethodDto
- UserDto
- UserList
- WhoamiDto
Documentation For Authorization #
Authentication schemes defined for the API:
HeritageTokenAuth #
- Type: API key
- API key parameter name: authorization
- Location: HTTP header
UserTokenAuth #
- Type: API key
- API key parameter name: authorization
- Location: HTTP header
ProjectTokenAuth #
- Type: API key
- API key parameter name: authorization
- Location: HTTP header
ConsumerTokenAuth #
- Type: API key
- API key parameter name: authorization
- Location: HTTP header
Author #
Metadata
0
likes
115
points
492
downloads
Publisher
Weekly Downloads
Metadata
Affinidi TDK dart client for Affinidi IAM
Repository (GitHub)
View/report issues
Contributing
Documentation
License
Apache-2.0 (license)
Dependencies
built_collection, built_value, dio, one_of, one_of_serializer