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: v1.2.9
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.dev

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

dependencies:
  ory_client: 1.2.9

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().getCourierApi();
final String id = id_example; // String | MessageID is the ID of the message.

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

Documentation for API Endpoints

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

Class Method HTTP request Description
CourierApi getCourierMessage GET /admin/courier/messages/{id} Get a Message
CourierApi listCourierMessages GET /admin/courier/messages List Messages
FrontendApi createBrowserLoginFlow GET /self-service/login/browser Create Login Flow for Browsers
FrontendApi createBrowserLogoutFlow GET /self-service/logout/browser Create a Logout URL for Browsers
FrontendApi createBrowserRecoveryFlow GET /self-service/recovery/browser Create Recovery Flow for Browsers
FrontendApi createBrowserRegistrationFlow GET /self-service/registration/browser Create Registration Flow for Browsers
FrontendApi createBrowserSettingsFlow GET /self-service/settings/browser Create Settings Flow for Browsers
FrontendApi createBrowserVerificationFlow GET /self-service/verification/browser Create Verification Flow for Browser Clients
FrontendApi createNativeLoginFlow GET /self-service/login/api Create Login Flow for Native Apps
FrontendApi createNativeRecoveryFlow GET /self-service/recovery/api Create Recovery Flow for Native Apps
FrontendApi createNativeRegistrationFlow GET /self-service/registration/api Create Registration Flow for Native Apps
FrontendApi createNativeSettingsFlow GET /self-service/settings/api Create Settings Flow for Native Apps
FrontendApi createNativeVerificationFlow GET /self-service/verification/api Create Verification Flow for Native Apps
FrontendApi disableMyOtherSessions DELETE /sessions Disable my other sessions
FrontendApi disableMySession DELETE /sessions/{id} Disable one of my sessions
FrontendApi exchangeSessionToken GET /sessions/token-exchange Exchange Session Token
FrontendApi getFlowError GET /self-service/errors Get User-Flow Errors
FrontendApi getLoginFlow GET /self-service/login/flows Get Login Flow
FrontendApi getRecoveryFlow GET /self-service/recovery/flows Get Recovery Flow
FrontendApi getRegistrationFlow GET /self-service/registration/flows Get Registration Flow
FrontendApi getSettingsFlow GET /self-service/settings/flows Get Settings Flow
FrontendApi getVerificationFlow GET /self-service/verification/flows Get Verification Flow
FrontendApi getWebAuthnJavaScript GET /.well-known/ory/webauthn.js Get WebAuthn JavaScript
FrontendApi listMySessions GET /sessions Get My Active Sessions
FrontendApi performNativeLogout DELETE /self-service/logout/api Perform Logout for Native Apps
FrontendApi toSession GET /sessions/whoami Check Who the Current HTTP Session Belongs To
FrontendApi updateLoginFlow POST /self-service/login Submit a Login Flow
FrontendApi updateLogoutFlow GET /self-service/logout Update Logout Flow
FrontendApi updateRecoveryFlow POST /self-service/recovery Complete Recovery Flow
FrontendApi updateRegistrationFlow POST /self-service/registration Update Registration Flow
FrontendApi updateSettingsFlow POST /self-service/settings Complete Settings Flow
FrontendApi updateVerificationFlow POST /self-service/verification Complete Verification Flow
IdentityApi batchPatchIdentities PATCH /admin/identities Create and deletes multiple identities
IdentityApi createIdentity POST /admin/identities Create an Identity
IdentityApi createRecoveryCodeForIdentity POST /admin/recovery/code Create a Recovery Code
IdentityApi createRecoveryLinkForIdentity POST /admin/recovery/link Create a Recovery Link
IdentityApi deleteIdentity DELETE /admin/identities/{id} Delete an Identity
IdentityApi deleteIdentityCredentials DELETE /admin/identities/{id}/credentials/{type} Delete a credential for a specific identity
IdentityApi deleteIdentitySessions DELETE /admin/identities/{id}/sessions Delete & Invalidate an Identity's Sessions
IdentityApi disableSession DELETE /admin/sessions/{id} Deactivate a Session
IdentityApi extendSession PATCH /admin/sessions/{id}/extend Extend a Session
IdentityApi getIdentity GET /admin/identities/{id} Get an Identity
IdentityApi getIdentitySchema GET /schemas/{id} Get Identity JSON Schema
IdentityApi getSession GET /admin/sessions/{id} Get Session
IdentityApi listIdentities GET /admin/identities List Identities
IdentityApi listIdentitySchemas GET /schemas Get all Identity Schemas
IdentityApi listIdentitySessions GET /admin/identities/{id}/sessions List an Identity's Sessions
IdentityApi listSessions GET /admin/sessions List All Sessions
IdentityApi patchIdentity PATCH /admin/identities/{id} Patch an Identity
IdentityApi updateIdentity PUT /admin/identities/{id} Update an Identity
JwkApi createJsonWebKeySet POST /admin/keys/{set} Create JSON Web Key
JwkApi deleteJsonWebKey DELETE /admin/keys/{set}/{kid} Delete JSON Web Key
JwkApi deleteJsonWebKeySet DELETE /admin/keys/{set} Delete JSON Web Key Set
JwkApi getJsonWebKey GET /admin/keys/{set}/{kid} Get JSON Web Key
JwkApi getJsonWebKeySet GET /admin/keys/{set} Retrieve a JSON Web Key Set
JwkApi setJsonWebKey PUT /admin/keys/{set}/{kid} Set JSON Web Key
JwkApi setJsonWebKeySet PUT /admin/keys/{set} Update a JSON Web Key Set
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
OAuth2Api acceptOAuth2ConsentRequest PUT /admin/oauth2/auth/requests/consent/accept Accept OAuth 2.0 Consent Request
OAuth2Api acceptOAuth2LoginRequest PUT /admin/oauth2/auth/requests/login/accept Accept OAuth 2.0 Login Request
OAuth2Api acceptOAuth2LogoutRequest PUT /admin/oauth2/auth/requests/logout/accept Accept OAuth 2.0 Session Logout Request
OAuth2Api createOAuth2Client POST /admin/clients Create OAuth 2.0 Client
OAuth2Api deleteOAuth2Client DELETE /admin/clients/{id} Delete OAuth 2.0 Client
OAuth2Api deleteOAuth2Token DELETE /admin/oauth2/tokens Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
OAuth2Api deleteTrustedOAuth2JwtGrantIssuer DELETE /admin/trust/grants/jwt-bearer/issuers/{id} Delete Trusted OAuth2 JWT Bearer Grant Type Issuer
OAuth2Api getOAuth2Client GET /admin/clients/{id} Get an OAuth 2.0 Client
OAuth2Api getOAuth2ConsentRequest GET /admin/oauth2/auth/requests/consent Get OAuth 2.0 Consent Request
OAuth2Api getOAuth2LoginRequest GET /admin/oauth2/auth/requests/login Get OAuth 2.0 Login Request
OAuth2Api getOAuth2LogoutRequest GET /admin/oauth2/auth/requests/logout Get OAuth 2.0 Session Logout Request
OAuth2Api getTrustedOAuth2JwtGrantIssuer GET /admin/trust/grants/jwt-bearer/issuers/{id} Get Trusted OAuth2 JWT Bearer Grant Type Issuer
OAuth2Api introspectOAuth2Token POST /admin/oauth2/introspect Introspect OAuth2 Access and Refresh Tokens
OAuth2Api listOAuth2Clients GET /admin/clients List OAuth 2.0 Clients
OAuth2Api listOAuth2ConsentSessions GET /admin/oauth2/auth/sessions/consent List OAuth 2.0 Consent Sessions of a Subject
OAuth2Api listTrustedOAuth2JwtGrantIssuers GET /admin/trust/grants/jwt-bearer/issuers List Trusted OAuth2 JWT Bearer Grant Type Issuers
OAuth2Api oAuth2Authorize GET /oauth2/auth OAuth 2.0 Authorize Endpoint
OAuth2Api oauth2TokenExchange POST /oauth2/token The OAuth 2.0 Token Endpoint
OAuth2Api patchOAuth2Client PATCH /admin/clients/{id} Patch OAuth 2.0 Client
OAuth2Api rejectOAuth2ConsentRequest PUT /admin/oauth2/auth/requests/consent/reject Reject OAuth 2.0 Consent Request
OAuth2Api rejectOAuth2LoginRequest PUT /admin/oauth2/auth/requests/login/reject Reject OAuth 2.0 Login Request
OAuth2Api rejectOAuth2LogoutRequest PUT /admin/oauth2/auth/requests/logout/reject Reject OAuth 2.0 Session Logout Request
OAuth2Api revokeOAuth2ConsentSessions DELETE /admin/oauth2/auth/sessions/consent Revoke OAuth 2.0 Consent Sessions of a Subject
OAuth2Api revokeOAuth2LoginSessions DELETE /admin/oauth2/auth/sessions/login Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
OAuth2Api revokeOAuth2Token POST /oauth2/revoke Revoke OAuth 2.0 Access or Refresh Token
OAuth2Api setOAuth2Client PUT /admin/clients/{id} Set OAuth 2.0 Client
OAuth2Api setOAuth2ClientLifespans PUT /admin/clients/{id}/lifespans Set OAuth2 Client Token Lifespans
OAuth2Api trustOAuth2JwtGrantIssuer POST /admin/trust/grants/jwt-bearer/issuers Trust OAuth2 JWT Bearer Grant Type Issuer
OidcApi createOidcDynamicClient POST /oauth2/register Register OAuth2 Client using OpenID Dynamic Client Registration
OidcApi createVerifiableCredential POST /credentials Issues a Verifiable Credential
OidcApi deleteOidcDynamicClient DELETE /oauth2/register/{id} Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
OidcApi discoverOidcConfiguration GET /.well-known/openid-configuration OpenID Connect Discovery
OidcApi getOidcDynamicClient GET /oauth2/register/{id} Get OAuth2 Client using OpenID Dynamic Client Registration
OidcApi getOidcUserInfo GET /userinfo OpenID Connect Userinfo
OidcApi revokeOidcSession GET /oauth2/sessions/logout OpenID Connect Front- and Back-channel Enabled Logout
OidcApi setOidcDynamicClient PUT /oauth2/register/{id} Set OAuth2 Client using OpenID Dynamic Client Registration
PermissionApi checkPermission GET /relation-tuples/check/openapi Check a permission
PermissionApi checkPermissionOrError GET /relation-tuples/check Check a permission
PermissionApi expandPermissions GET /relation-tuples/expand Expand a Relationship into permissions.
PermissionApi postCheckPermission POST /relation-tuples/check/openapi Check a permission
PermissionApi postCheckPermissionOrError POST /relation-tuples/check Check a permission
ProjectApi createProject POST /projects Create a Project
ProjectApi createProjectApiKey POST /projects/{project}/tokens Create project API token
ProjectApi deleteProjectApiKey DELETE /projects/{project}/tokens/{token_id} Delete project API token
ProjectApi getActiveProjectInConsole GET /console/active/project Returns the Ory Network Project selected in the Ory Network Console
ProjectApi getProject GET /projects/{project_id} Get a Project
ProjectApi getProjectMembers GET /projects/{project}/members Get all members associated with this project
ProjectApi getProjectMetrics GET /projects/{project_id}/metrics
ProjectApi listProjectApiKeys GET /projects/{project}/tokens List a project's API Tokens
ProjectApi listProjects GET /projects List All Projects
ProjectApi patchProject PATCH /projects/{project_id} Patch an Ory Network Project Configuration
ProjectApi purgeProject DELETE /projects/{project_id} Irrecoverably purge a project
ProjectApi removeProjectMember DELETE /projects/{project}/members/{member} Remove a member associated with this project
ProjectApi setActiveProjectInConsole PUT /console/active/project Sets the Ory Network Project active in the Ory Network Console
ProjectApi setProject PUT /projects/{project_id} Update an Ory Network Project Configuration
RelationshipApi checkOplSyntax POST /opl/syntax/check Check the syntax of an OPL file
RelationshipApi createRelationship PUT /admin/relation-tuples Create a Relationship
RelationshipApi deleteRelationships DELETE /admin/relation-tuples Delete Relationships
RelationshipApi getRelationships GET /relation-tuples Query relationships
RelationshipApi listRelationshipNamespaces GET /namespaces Query namespaces
RelationshipApi patchRelationships PATCH /admin/relation-tuples Patch Multiple Relationships
WellknownApi discoverJsonWebKeys GET /.well-known/jwks.json Discover Well-Known JSON Web Keys

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

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

Libraries

ory_client