optare_api_core

# OptareID API

Enterprise-grade identity and access management API.

## Authentication

All API endpoints require authentication using a Bearer token. You can obtain a token by:
1. Using OAuth 2.0 authorization code flow
2. Using API keys for server-to-server communication

Include the token in the `Authorization` header:
```
Authorization: Bearer YOUR_TOKEN
```

## Rate Limiting

API requests are rate limited to 100 requests per minute per API key.
Rate limit headers are included in all responses:
- `X-RateLimit-Limit`: Maximum requests per window
- `X-RateLimit-Remaining`: Remaining requests
- `X-RateLimit-Reset`: Unix timestamp when limit resets

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Generator version: 7.18.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://docs.optare.one

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  optare_api_core:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  optare_api_core:
    path: /path/to/optare_api_core

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:optare_api_core/api.dart';

// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = APIKeysApi();
final id = id_example; // String | 

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

Documentation for API Endpoints

All URIs are relative to https://id.optare.one

Class Method HTTP request Description
APIKeysApi apiV1ApiKeysDelete DELETE /api/v1/api-keys Delete API key
APIKeysApi apiV1ApiKeysGet GET /api/v1/api-keys List API keys
APIKeysApi apiV1ApiKeysPost POST /api/v1/api-keys Create API key
BillingApi apiV1BillingConfigPut PUT /api/v1/billing/config Configure billing
BillingApi apiV1BillingPortalPost POST /api/v1/billing/portal Create billing portal session
BillingApi apiV1BillingProductsGet GET /api/v1/billing/products List billing products
BillingApi apiV1BillingSubscribePost POST /api/v1/billing/subscribe Create subscription checkout
LicensesApi apiV1LicensesCheckGet GET /api/v1/licenses/check Check feature access
LicensesApi apiV1LicensesEntitlementsGet GET /api/v1/licenses/entitlements List entitlements
LicensesApi apiV1LicensesGet GET /api/v1/licenses List licenses
OAuthClientsApi apiV1OauthClientsGet GET /api/v1/oauth-clients List OAuth clients
OAuthClientsApi apiV1OauthClientsPost POST /api/v1/oauth-clients Create OAuth client
OrganizationsApi apiV1OrganizationsGet GET /api/v1/organizations List organizations
OrganizationsApi apiV1OrganizationsIdDelete DELETE /api/v1/organizations/{id} Delete organization
OrganizationsApi apiV1OrganizationsIdGet GET /api/v1/organizations/{id} Get organization
OrganizationsApi apiV1OrganizationsIdInvitePost POST /api/v1/organizations/{id}/invite Invite user to organization
OrganizationsApi apiV1OrganizationsIdPatch PATCH /api/v1/organizations/{id} Update organization
OrganizationsApi apiV1OrganizationsPost POST /api/v1/organizations Create organization
ProductsApi apiV1ProductsGet GET /api/v1/products List products
ProductsApi apiV1ProductsIdDelete DELETE /api/v1/products/{id} Delete product
ProductsApi apiV1ProductsIdGet GET /api/v1/products/{id} Get product
ProductsApi apiV1ProductsIdPatch PATCH /api/v1/products/{id} Update product
SubscriptionsApi apiV1SubscriptionsGet GET /api/v1/subscriptions List subscriptions
SubscriptionsApi apiV1SubscriptionsPost POST /api/v1/subscriptions Create subscription
UsersApi apiV1UsersGet GET /api/v1/users List users
UsersApi apiV1UsersIdGet GET /api/v1/users/{id} Get user
UsersApi apiV1UsersMeDelete DELETE /api/v1/users/me Delete current user
UsersApi apiV1UsersMeGet GET /api/v1/users/me Get current user
UsersApi apiV1UsersMePatch PATCH /api/v1/users/me Update current user
UsersApi apiV1UsersPost POST /api/v1/users Create user
WebhooksApi apiV1WebhooksGet GET /api/v1/webhooks List webhooks
WebhooksApi apiV1WebhooksIdDelete DELETE /api/v1/webhooks/{id} Delete webhook
WebhooksApi apiV1WebhooksIdGet GET /api/v1/webhooks/{id} Get webhook
WebhooksApi apiV1WebhooksIdPatch PATCH /api/v1/webhooks/{id} Update webhook
WebhooksApi apiV1WebhooksPost POST /api/v1/webhooks Create webhook

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP Bearer authentication

Author

support@optare.one

Libraries

api