affinidi_tdk_login_configuration_client 2.0.0
affinidi_tdk_login_configuration_client: ^2.0.0 copied to clipboard
Affinidi TDK dart client for Affinidi LOGIN CONFIGURATION
affinidi_tdk_login_configuration_client #
Affinidi TDK dart client for Affinidi LOGIN CONFIGURATION
Requirements #
- Dart 3.8.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_login_configuration_client: ^2.0.0
Github #
This Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
affinidi_tdk_login_configuration_client:
git:
url: https://github.com/affinidi/affinidi-tdk-dart.git
ref: main
path: clients/login_configuration_client
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
affinidi_tdk_login_configuration_client:
path: /path/to/affinidi_tdk_login_configuration_client
Install dependencies #
dart pub get
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:affinidi_tdk_login_configuration_client/affinidi_tdk_login_configuration_client.dart';
final api = AffinidiTdkLoginConfigurationClient().getAllowListApi();
final GroupNamesInput groupNamesInput = ; // GroupNamesInput | List of group names as input
try {
api.allowGroups(groupNamesInput);
} catch on DioException (e) {
print("Exception when calling AllowListApi->allowGroups: $e\n");
}
Documentation for API Endpoints #
All URIs are relative to https://apse1.api.affinidi.io/vpa
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AllowListApi | allowGroups | POST /v1/allow-list/groups/add | |
| AllowListApi | disallowGroups | POST /v1/allow-list/groups/remove | |
| AllowListApi | listAllowedGroups | GET /v1/allow-list/groups | |
| ConfigurationApi | createLoginConfigurations | POST /v1/login/configurations | Create a new login configuration |
| ConfigurationApi | deleteLoginConfigurationsById | DELETE /v1/login/configurations/{configurationId} | Delete login configurations by ID |
| ConfigurationApi | getClientMetadataByClientId | GET /v1/login/configurations/metadata/{clientId} | Get Client Metadata By OAuth 2.0 Client ID |
| ConfigurationApi | getLoginConfigurationsById | GET /v1/login/configurations/{configurationId} | Get login configuration by ID |
| ConfigurationApi | listLoginConfigurations | GET /v1/login/configurations | List login configurations |
| ConfigurationApi | updateLoginConfigurationsById | PATCH /v1/login/configurations/{configurationId} | Update login configurations by ID |
| DenyListApi | blockGroups | POST /v1/deny-list/groups/add | |
| DenyListApi | blockUsers | POST /v1/deny-list/users/add | |
| DenyListApi | listBlockedGroups | GET /v1/deny-list/groups | |
| DenyListApi | listBlockedUsers | GET /v1/deny-list/users | |
| DenyListApi | unblockGroups | POST /v1/deny-list/groups/remove | |
| DenyListApi | unblockUsers | POST /v1/deny-list/users/remove | |
| GroupApi | addUserToGroup | POST /v1/groups/{groupName}/users | |
| GroupApi | createGroup | POST /v1/groups | |
| GroupApi | deleteGroup | DELETE /v1/groups/{groupName} | |
| GroupApi | getGroupById | GET /v1/groups/{groupName} | |
| GroupApi | listGroupUserMappings | GET /v1/groups/{groupName}/users | |
| GroupApi | listGroups | GET /v1/groups | |
| GroupApi | removeUserFromGroup | DELETE /v1/groups/{groupName}/users | |
| IdpApi | v1LoginProjectProjectIdOauth2AuthGet | GET /v1/login/project/{projectId}/oauth2/auth | OAuth 2.0 Authorize Endpoint |
| IdpApi | v1LoginProjectProjectIdOauth2RevokePost | POST /v1/login/project/{projectId}/oauth2/revoke | Revoke OAuth 2.0 Access or Refresh Token |
| IdpApi | v1LoginProjectProjectIdOauth2SessionsLogoutGet | GET /v1/login/project/{projectId}/oauth2/sessions/logout | OpenID Connect Front- and Back-channel Enabled Logout |
| IdpApi | v1LoginProjectProjectIdOauth2TokenPost | POST /v1/login/project/{projectId}/oauth2/token | The OAuth 2.0 Token Endpoint |
| IdpApi | v1LoginProjectProjectIdUserinfoGet | GET /v1/login/project/{projectId}/userinfo | OpenID Connect Userinfo |
| IdpApi | v1LoginProjectProjectIdWellKnownJwksJsonGet | GET /v1/login/project/{projectId}/.well-known/jwks.json | Discover Well-Known JSON Web Keys |
| IdpApi | v1LoginProjectProjectIdWellKnownOpenidConfigurationGet | GET /v1/login/project/{projectId}/.well-known/openid-configuration | OpenID Connect Discovery |
Documentation For Models #
- ActionForbiddenError
- AddUserToGroupInput
- BlockedUsers
- BlockedUsersInput
- CreateGroupInput
- CreateHydraNetworkError
- CreateLoginConfigurationInput
- CreateLoginConfigurationOutput
- CreateLoginConfigurationOutputAuth
- CreateLoginConfigurations400Response
- CreateProjectNetworkError
- GetUserInfo
- GroupDto
- GroupNames
- GroupNamesInput
- GroupUserMappingDto
- GroupUserMappingsList
- GroupsList
- GroupsPerUserLimitExceededError
- IdTokenMappingItem
- InvalidGroupsError
- InvalidParameterError
- InvalidParameterErrorDetailsInner
- JsonWebKey
- JsonWebKeyKeysInner
- ListLoginConfigurationOutput
- LoginConfigurationClientMetadataInput
- LoginConfigurationClientMetadataOutput
- LoginConfigurationObject
- NotFoundError
- OAuth2Token
- OAuth2TokenAuthorizationDetailsInner
- OIDCConfig
- OIDCConfigCredentialsSupportedDraft00Inner
- RemoveUserFromGroupInput
- ResourceCreationError
- TokenEndpointAuthMethod
- UpdateLoginConfigurationInput
Documentation For Authorization #
Authentication schemes defined for the API:
AwsSigV4 #
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
ApiKey #
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
bearerAuth #
- Type: HTTP Bearer Token authentication (JWT)
ConsumerTokenAuth #
- 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