ory_client 0.2.0-alpha.60 copy "ory_client: ^0.2.0-alpha.60" to clipboard
ory_client: ^0.2.0-alpha.60 copied to clipboard

Published 18 months ago • verified publisherory.sh• Latest: 1.6.2
[unknown platforms]
→

Metadata

OpenAPI API client

More...

ory_client (EXPERIMENTAL) #

Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.

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

  • API version: v0.2.0-alpha.60
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements #

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage #

pub.dev #

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  ory_client: 0.2.0-alpha.60

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  ory_client:
    git:
      url: https://github.com/ory/sdk.git
      #ref: main

Local development #

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  ory_client:
    path: /path/to/ory_client

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:ory_client/ory_client.dart';


final api = OryClient().getAdminApi();
final String id = id_example; // String | The id of the OAuth 2.0 Client.
final UpdateOAuth2ClientLifespans updateOAuth2ClientLifespans = ; // UpdateOAuth2ClientLifespans | 

try {
    final response = await api.updateOAuth2ClientLifespans(id, updateOAuth2ClientLifespans);
    print(response);
} catch on DioError (e) {
    print("Exception when calling AdminApi->updateOAuth2ClientLifespans: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://playground.projects.oryapis.com

Class Method HTTP request Description
AdminApi updateOAuth2ClientLifespans PUT /admin/clients/{id}/lifespans
MetadataApi getVersion GET /version Return Running Software Version.
MetadataApi isAlive GET /health/alive Check HTTP Server Status
MetadataApi isReady GET /health/ready Check HTTP Server and Database Status
NamespacesApi getNamespaces GET /namespaces Query namespaces
ReadApi getCheck GET /relation-tuples/check/openapi Check a relation tuple
ReadApi getCheckMirrorStatus GET /relation-tuples/check Check a relation tuple
ReadApi getExpand GET /relation-tuples/expand Expand a Relation Tuple
ReadApi getRelationTuples GET /relation-tuples Query relation tuples
ReadApi postCheck POST /relation-tuples/check/openapi Check a relation tuple
ReadApi postCheckMirrorStatus POST /relation-tuples/check Check a relation tuple
SyntaxApi checkOplSyntax POST /opl/syntax/check Check the syntax of an OPL file
V0alpha2Api adminAcceptOAuth2ConsentRequest PUT /admin/oauth2/auth/requests/consent/accept Accept an OAuth 2.0 Consent Request
V0alpha2Api adminAcceptOAuth2LoginRequest PUT /admin/oauth2/auth/requests/login/accept Accept an OAuth 2.0 Login Request
V0alpha2Api adminAcceptOAuth2LogoutRequest PUT /admin/oauth2/auth/requests/logout/accept Accept an OAuth 2.0 Logout Request
V0alpha2Api adminCreateIdentity POST /admin/identities Create an Identity
V0alpha2Api adminCreateJsonWebKeySet POST /admin/keys/{set} Generate a New JSON Web Key
V0alpha2Api adminCreateOAuth2Client POST /admin/clients Create an OAuth 2.0 Client
V0alpha2Api adminCreateSelfServiceRecoveryCode POST /admin/recovery/code Create a Recovery Link
V0alpha2Api adminCreateSelfServiceRecoveryLink POST /admin/recovery/link Create a Recovery Link
V0alpha2Api adminDeleteIdentity DELETE /admin/identities/{id} Delete an Identity
V0alpha2Api adminDeleteIdentitySessions DELETE /admin/identities/{id}/sessions Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
V0alpha2Api adminDeleteJsonWebKey DELETE /admin/keys/{set}/{kid} Delete a JSON Web Key
V0alpha2Api adminDeleteJsonWebKeySet DELETE /admin/keys/{set} Delete a JSON Web Key Set
V0alpha2Api adminDeleteOAuth2Client DELETE /admin/clients/{id} Deletes an OAuth 2.0 Client
V0alpha2Api adminDeleteOAuth2Token DELETE /admin/oauth2/tokens Delete OAuth2 Access Tokens from a Client
V0alpha2Api adminDeleteTrustedOAuth2JwtGrantIssuer DELETE /admin/trust/grants/jwt-bearer/issuers/{id} Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
V0alpha2Api adminExtendSession PATCH /admin/sessions/{id}/extend Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed.
V0alpha2Api adminGetIdentity GET /admin/identities/{id} Get an Identity
V0alpha2Api adminGetJsonWebKey GET /admin/keys/{set}/{kid} Fetch a JSON Web Key
V0alpha2Api adminGetJsonWebKeySet GET /admin/keys/{set} Retrieve a JSON Web Key Set
V0alpha2Api adminGetOAuth2Client GET /admin/clients/{id} Get an OAuth 2.0 Client
V0alpha2Api adminGetOAuth2ConsentRequest GET /admin/oauth2/auth/requests/consent Get OAuth 2.0 Consent Request Information
V0alpha2Api adminGetOAuth2LoginRequest GET /admin/oauth2/auth/requests/login Get an OAuth 2.0 Login Request
V0alpha2Api adminGetOAuth2LogoutRequest GET /admin/oauth2/auth/requests/logout Get an OAuth 2.0 Logout Request
V0alpha2Api adminGetTrustedOAuth2JwtGrantIssuer GET /admin/trust/grants/jwt-bearer/issuers/{id} Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
V0alpha2Api adminIntrospectOAuth2Token POST /admin/oauth2/introspect Introspect OAuth2 Access or Refresh Tokens
V0alpha2Api adminListCourierMessages GET /admin/courier/messages List Messages
V0alpha2Api adminListIdentities GET /admin/identities List Identities
V0alpha2Api adminListIdentitySessions GET /admin/identities/{id}/sessions This endpoint returns all sessions that belong to the given Identity.
V0alpha2Api adminListOAuth2Clients GET /admin/clients List OAuth 2.0 Clients
V0alpha2Api adminListOAuth2SubjectConsentSessions GET /admin/oauth2/auth/sessions/consent List OAuth 2.0 Consent Sessions of a Subject
V0alpha2Api adminListTrustedOAuth2JwtGrantIssuers GET /admin/trust/grants/jwt-bearer/issuers List Trusted OAuth2 JWT Bearer Grant Type Issuers
V0alpha2Api adminPatchIdentity PATCH /admin/identities/{id} Patch an Identity
V0alpha2Api adminPatchOAuth2Client PATCH /admin/clients/{id} Patch an OAuth 2.0 Client
V0alpha2Api adminRejectOAuth2ConsentRequest PUT /admin/oauth2/auth/requests/consent/reject Reject an OAuth 2.0 Consent Request
V0alpha2Api adminRejectOAuth2LoginRequest PUT /admin/oauth2/auth/requests/login/reject Reject an OAuth 2.0 Login Request
V0alpha2Api adminRejectOAuth2LogoutRequest PUT /admin/oauth2/auth/requests/logout/reject Reject an OAuth 2.0 Logout Request
V0alpha2Api adminRevokeOAuth2ConsentSessions DELETE /admin/oauth2/auth/sessions/consent Revokes OAuth 2.0 Consent Sessions of a Subject for a Specific OAuth 2.0 Client
V0alpha2Api adminRevokeOAuth2LoginSessions DELETE /admin/oauth2/auth/sessions/login Invalidates All OAuth 2.0 Login Sessions of a Certain User
V0alpha2Api adminTrustOAuth2JwtGrantIssuer POST /admin/trust/grants/jwt-bearer/issuers Trust an OAuth2 JWT Bearer Grant Type Issuer
V0alpha2Api adminUpdateIdentity PUT /admin/identities/{id} Update an Identity
V0alpha2Api adminUpdateJsonWebKey PUT /admin/keys/{set}/{kid} Update a JSON Web Key
V0alpha2Api adminUpdateJsonWebKeySet PUT /admin/keys/{set} Update a JSON Web Key Set
V0alpha2Api adminUpdateOAuth2Client PUT /admin/clients/{id} Update an OAuth 2.0 Client
V0alpha2Api createProject POST /projects Create a Project
V0alpha2Api createProjectApiKey POST /projects/{project}/tokens Create API Token
V0alpha2Api createSelfServiceLogoutFlowUrlForBrowsers GET /self-service/logout/browser Create a Logout URL for Browsers
V0alpha2Api deleteProjectApiKey DELETE /projects/{project}/tokens/{token_id} Delete API Token
V0alpha2Api discoverJsonWebKeys GET /.well-known/jwks.json Discover JSON Web Keys
V0alpha2Api discoverOidcConfiguration GET /.well-known/openid-configuration OpenID Connect Discovery
V0alpha2Api dynamicClientRegistrationCreateOAuth2Client POST /oauth2/register Register an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
V0alpha2Api dynamicClientRegistrationDeleteOAuth2Client DELETE /oauth2/register/{id} Deletes an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
V0alpha2Api dynamicClientRegistrationGetOAuth2Client GET /oauth2/register/{id} Get an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
V0alpha2Api dynamicClientRegistrationUpdateOAuth2Client PUT /oauth2/register/{id} Update an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
V0alpha2Api getIdentitySchema GET /schemas/{id}
V0alpha2Api getOidcUserInfo GET /userinfo OpenID Connect Userinfo
V0alpha2Api getProject GET /projects/{project_id} Get a Project
V0alpha2Api getProjectMembers GET /projects/{project_id}/members Get all members associated with this project.
V0alpha2Api getSelfServiceError GET /self-service/errors Get Self-Service Errors
V0alpha2Api getSelfServiceLoginFlow GET /self-service/login/flows Get Login Flow
V0alpha2Api getSelfServiceRecoveryFlow GET /self-service/recovery/flows Get Recovery Flow
V0alpha2Api getSelfServiceRegistrationFlow GET /self-service/registration/flows Get Registration Flow
V0alpha2Api getSelfServiceSettingsFlow GET /self-service/settings/flows Get Settings Flow
V0alpha2Api getSelfServiceVerificationFlow GET /self-service/verification/flows Get Verification Flow
V0alpha2Api getWebAuthnJavaScript GET /.well-known/ory/webauthn.js Get WebAuthn JavaScript
V0alpha2Api initializeSelfServiceLoginFlowForBrowsers GET /self-service/login/browser Initialize Login Flow for Browsers
V0alpha2Api initializeSelfServiceLoginFlowWithoutBrowser GET /self-service/login/api Initialize Login Flow for APIs, Services, Apps, ...
V0alpha2Api initializeSelfServiceRecoveryFlowForBrowsers GET /self-service/recovery/browser Initialize Recovery Flow for Browsers
V0alpha2Api initializeSelfServiceRecoveryFlowWithoutBrowser GET /self-service/recovery/api Initialize Recovery Flow for APIs, Services, Apps, ...
V0alpha2Api initializeSelfServiceRegistrationFlowForBrowsers GET /self-service/registration/browser Initialize Registration Flow for Browsers
V0alpha2Api initializeSelfServiceRegistrationFlowWithoutBrowser GET /self-service/registration/api Initialize Registration Flow for APIs, Services, Apps, ...
V0alpha2Api initializeSelfServiceSettingsFlowForBrowsers GET /self-service/settings/browser Initialize Settings Flow for Browsers
V0alpha2Api initializeSelfServiceSettingsFlowWithoutBrowser GET /self-service/settings/api Initialize Settings Flow for APIs, Services, Apps, ...
V0alpha2Api initializeSelfServiceVerificationFlowForBrowsers GET /self-service/verification/browser Initialize Verification Flow for Browser Clients
V0alpha2Api initializeSelfServiceVerificationFlowWithoutBrowser GET /self-service/verification/api Initialize Verification Flow for APIs, Services, Apps, ...
V0alpha2Api listIdentitySchemas GET /schemas
V0alpha2Api listProjectApiKeys GET /projects/{project}/tokens List a Project's API Tokens
V0alpha2Api listProjects GET /projects List All Projects
V0alpha2Api listSessions GET /sessions This endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the `/sessions/whoami` endpoint.
V0alpha2Api patchProject PATCH /projects/{project_id} Patch an Ory Cloud Project Configuration`
V0alpha2Api performOAuth2AuthorizationFlow GET /oauth2/auth The OAuth 2.0 Authorize Endpoint
V0alpha2Api performOAuth2TokenFlow POST /oauth2/token The OAuth 2.0 Token Endpoint
V0alpha2Api performOidcFrontOrBackChannelLogout GET /oauth2/sessions/logout OpenID Connect Front- or Back-channel Enabled Logout
V0alpha2Api purgeProject DELETE /projects/{project_id} Irrecoverably Purge a Project
V0alpha2Api removeProjectMember DELETE /projects/{project_id}/members/{member_id} Remove a member associated with this project. This also sets their invite status to `REMOVED`.
V0alpha2Api revokeOAuth2Token POST /oauth2/revoke Revoke an OAuth2 Access or Refresh Token
V0alpha2Api revokeSession DELETE /sessions/{id} Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted.
V0alpha2Api revokeSessions DELETE /sessions Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted.
V0alpha2Api submitSelfServiceLoginFlow POST /self-service/login Submit a Login Flow
V0alpha2Api submitSelfServiceLogoutFlow GET /self-service/logout Complete Self-Service Logout
V0alpha2Api submitSelfServiceLogoutFlowWithoutBrowser DELETE /self-service/logout/api Perform Logout for APIs, Services, Apps, ...
V0alpha2Api submitSelfServiceRecoveryFlow POST /self-service/recovery Complete Recovery Flow
V0alpha2Api submitSelfServiceRegistrationFlow POST /self-service/registration Submit a Registration Flow
V0alpha2Api submitSelfServiceSettingsFlow POST /self-service/settings Complete Settings Flow
V0alpha2Api submitSelfServiceVerificationFlow POST /self-service/verification Complete Verification Flow
V0alpha2Api toSession GET /sessions/whoami Check Who the Current HTTP Session Belongs To
V0alpha2Api updateProject PUT /projects/{project_id} Update an Ory Cloud Project Configuration
WriteApi createRelationTuple PUT /admin/relation-tuples Create a Relation Tuple
WriteApi deleteRelationTuples DELETE /admin/relation-tuples Delete Relation Tuples
WriteApi patchRelationTuples PATCH /admin/relation-tuples Patch Multiple Relation Tuples

Documentation For Models #

Documentation For Authorization #

basic #

  • Type: HTTP basic authentication

bearer #

  • Type: HTTP basic authentication

oauth2 #

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://hydra.demo.ory.sh/oauth2/auth
  • Scopes:
  • offline: A scope required when requesting refresh tokens (alias for offline_access)
  • offline_access: A scope required when requesting refresh tokens
  • openid: Request an OpenID Connect ID Token

oryAccessToken #

  • Type: HTTP basic authentication

Author #

support@ory.sh

← Metadata

11
likes
0
pub points
76%
popularity

Publisher

verified publisherory.sh

Metadata

OpenAPI API client

Homepage

License

unknown (LICENSE)

Dependencies

built_collection, built_value, dio, one_of, one_of_serializer

More

Packages that depend on ory_client

Back