ory_client 0.2.0-alpha.31

OpenAPI API client

ory_client

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.31
• Build package: org.openapitools.codegen.languages.DartClientCodegen

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:
  ory_client:
    git: https://github.com/ory/sdk.git

Local

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

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

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:ory_client/api.dart';


final api_instance = AdminApi();
final consentChallenge = consentChallenge_example; // String | 
final acceptConsentRequest = AcceptConsentRequest(); // AcceptConsentRequest | 

try {
    final result = api_instance.acceptConsentRequest(consentChallenge, acceptConsentRequest);
    print(result);
} catch (e) {
    print('Exception when calling AdminApi->acceptConsentRequest: $e\n');
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AdminApi	acceptConsentRequest	PUT /oauth2/auth/requests/consent/accept	Accept a Consent Request
AdminApi	acceptLoginRequest	PUT /oauth2/auth/requests/login/accept	Accept a Login Request
AdminApi	acceptLogoutRequest	PUT /oauth2/auth/requests/logout/accept	Accept a Logout Request
AdminApi	createJsonWebKeySet	POST /keys/{set}	Generate a New JSON Web Key
AdminApi	createOAuth2Client	POST /clients	Create an OAuth 2.0 Client
AdminApi	deleteJsonWebKey	DELETE /keys/{set}/{kid}	Delete a JSON Web Key
AdminApi	deleteJsonWebKeySet	DELETE /keys/{set}	Delete a JSON Web Key Set
AdminApi	deleteOAuth2Client	DELETE /clients/{id}	Deletes an OAuth 2.0 Client
AdminApi	deleteOAuth2Token	DELETE /oauth2/tokens	Delete OAuth2 Access Tokens from a Client
AdminApi	deleteTrustedJwtGrantIssuer	DELETE /trust/grants/jwt-bearer/issuers/{id}	Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
AdminApi	flushInactiveOAuth2Tokens	POST /oauth2/flush	Flush Expired OAuth2 Access Tokens
AdminApi	getConsentRequest	GET /oauth2/auth/requests/consent	Get Consent Request Information
AdminApi	getJsonWebKey	GET /keys/{set}/{kid}	Fetch a JSON Web Key
AdminApi	getJsonWebKeySet	GET /keys/{set}	Retrieve a JSON Web Key Set
AdminApi	getLoginRequest	GET /oauth2/auth/requests/login	Get a Login Request
AdminApi	getLogoutRequest	GET /oauth2/auth/requests/logout	Get a Logout Request
AdminApi	getOAuth2Client	GET /clients/{id}	Get an OAuth 2.0 Client
AdminApi	getTrustedJwtGrantIssuer	GET /trust/grants/jwt-bearer/issuers/{id}	Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
AdminApi	introspectOAuth2Token	POST /oauth2/introspect	Introspect OAuth2 Tokens
AdminApi	listOAuth2Clients	GET /clients	List OAuth 2.0 Clients
AdminApi	listSubjectConsentSessions	GET /oauth2/auth/sessions/consent	Lists All Consent Sessions of a Subject
AdminApi	listTrustedJwtGrantIssuers	GET /trust/grants/jwt-bearer/issuers	List Trusted OAuth2 JWT Bearer Grant Type Issuers
AdminApi	patchOAuth2Client	PATCH /clients/{id}	Patch an OAuth 2.0 Client
AdminApi	rejectConsentRequest	PUT /oauth2/auth/requests/consent/reject	Reject a Consent Request
AdminApi	rejectLoginRequest	PUT /oauth2/auth/requests/login/reject	Reject a Login Request
AdminApi	rejectLogoutRequest	PUT /oauth2/auth/requests/logout/reject	Reject a Logout Request
AdminApi	revokeAuthenticationSession	DELETE /oauth2/auth/sessions/login	Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
AdminApi	revokeConsentSessions	DELETE /oauth2/auth/sessions/consent	Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
AdminApi	trustJwtGrantIssuer	POST /trust/grants/jwt-bearer/issuers	Trust an OAuth2 JWT Bearer Grant Type Issuer
AdminApi	updateJsonWebKey	PUT /keys/{set}/{kid}	Update a JSON Web Key
AdminApi	updateJsonWebKeySet	PUT /keys/{set}	Update a JSON Web Key Set
AdminApi	updateOAuth2Client	PUT /clients/{id}	Update an OAuth 2.0 Client
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
PublicApi	disconnectUser	GET /oauth2/sessions/logout	OpenID Connect Front-Backchannel Enabled Logout
PublicApi	discoverOpenIDConfiguration	GET /.well-known/openid-configuration	OpenID Connect Discovery
PublicApi	dynamicClientRegistrationCreateOAuth2Client	POST /connect/register	Register an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApi	dynamicClientRegistrationDeleteOAuth2Client	DELETE /connect/register/{id}	Deletes an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApi	dynamicClientRegistrationGetOAuth2Client	GET /connect/register/{id}	Get an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApi	dynamicClientRegistrationUpdateOAuth2Client	PUT /connect/register/{id}	Update an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApi	oauth2Token	POST /oauth2/token	The OAuth 2.0 Token Endpoint
PublicApi	oauthAuth	GET /oauth2/auth	The OAuth 2.0 Authorize Endpoint
PublicApi	revokeOAuth2Token	POST /oauth2/revoke	Revoke OAuth2 Tokens
PublicApi	userinfo	GET /userinfo	OpenID Connect Userinfo
PublicApi	wellKnown	GET /.well-known/jwks.json	JSON Web Keys Discovery
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
V0alpha2Api	adminCreateIdentity	POST /admin/identities	Create an Identity
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	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	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	adminPatchIdentity	PATCH /admin/identities/{id}	Partially updates an Identity's field using JSON Patch
V0alpha2Api	adminUpdateIdentity	PUT /admin/identities/{id}	Update an Identity
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	getIdentitySchema	GET /schemas/{id}
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	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	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

• AcceptConsentRequest
• AcceptLoginRequest
• ActiveProject
• AdminCreateIdentityBody
• AdminCreateIdentityImportCredentialsOidc
• AdminCreateIdentityImportCredentialsOidcConfig
• AdminCreateIdentityImportCredentialsOidcProvider
• AdminCreateIdentityImportCredentialsPassword
• AdminCreateIdentityImportCredentialsPasswordConfig
• AdminCreateSelfServiceRecoveryLinkBody
• AdminIdentityImportCredentials
• AdminUpdateIdentityBody
• AuthenticatorAssuranceLevel
• CloudAccount
• CnameSettings
• CompletedRequest
• ConsentRequest
• ConsentRequestSession
• CreateCustomHostnameBody
• CreateProjectApiKeyRequest
• CreateProjectBody
• CreateSubscriptionPayload
• ErrorAuthenticatorAssuranceLevelNotSatisfied
• ExpandTree
• FlushInactiveOAuth2TokensRequest
• FlushLoginConsentRequest
• GenericError
• GenericErrorContent
• GetCheckResponse
• GetManagedIdentitySchemaLocation
• GetRelationTuplesResponse
• GetVersion200Response
• HealthNotReadyStatus
• HealthStatus
• Identity
• IdentityCredentials
• IdentityCredentialsOidc
• IdentityCredentialsOidcProvider
• IdentityCredentialsPassword
• IdentityCredentialsType
• IdentitySchemaContainer
• IdentitySchemaPreset
• IdentityState
• InvitePayload
• IsOwnerForProjectBySlug
• IsOwnerForProjectBySlugPayload
• IsReady200Response
• IsReady503Response
• JSONWebKey
• JSONWebKeySet
• JsonError
• JsonPatch
• JsonWebKeySetGeneratorRequest
• KetoNamespace
• LoginRequest
• LogoutRequest
• ManagedIdentitySchema
• ManagedIdentitySchemaValidationResult
• NeedsPrivilegedSessionError
• NormalizedProject
• NormalizedProjectRevision
• NormalizedProjectRevisionHook
• NormalizedProjectRevisionIdentitySchema
• NormalizedProjectRevisionThirdPartyProvider
• NullPlan
• OAuth2Client
• OAuth2TokenIntrospection
• Oauth2TokenResponse
• OauthTokenResponse
• OpenIDConnectContext
• Pagination
• PatchDelta
• PatchDocument
• PreviousConsentSession
• Project
• ProjectApiKey
• ProjectHost
• ProjectInvite
• ProjectMetadata
• ProjectServiceIdentity
• ProjectServiceOAuth2
• ProjectServicePermission
• ProjectServices
• ProvisionMockSubscriptionPayload
• QuotaCustomDomains
• QuotaProjectMemberSeats
• RecoveryAddress
• RefreshTokenHookRequest
• RefreshTokenHookResponse
• RejectRequest
• RelationQuery
• RelationTuple
• RequestWasHandledResponse
• RevokedSessions
• SchemaPatch
• SelfServiceBrowserLocationChangeRequiredError
• SelfServiceError
• SelfServiceFlowExpiredError
• SelfServiceLoginFlow
• SelfServiceLogoutUrl
• SelfServiceRecoveryFlow
• SelfServiceRecoveryFlowState
• SelfServiceRecoveryLink
• SelfServiceRegistrationFlow
• SelfServiceSettingsFlow
• SelfServiceSettingsFlowState
• SelfServiceVerificationFlow
• SelfServiceVerificationFlowState
• Session
• SessionAuthenticationMethod
• SessionDevice
• SettingsProfileFormConfig
• StripeCustomerResponse
• SubjectSet
• SubmitSelfServiceFlowWithWebAuthnRegistrationMethod
• SubmitSelfServiceLoginFlowBody
• SubmitSelfServiceLoginFlowWithLookupSecretMethodBody
• SubmitSelfServiceLoginFlowWithOidcMethodBody
• SubmitSelfServiceLoginFlowWithPasswordMethodBody
• SubmitSelfServiceLoginFlowWithTotpMethodBody
• SubmitSelfServiceLoginFlowWithWebAuthnMethodBody
• SubmitSelfServiceLogoutFlowWithoutBrowserBody
• SubmitSelfServiceRecoveryFlowBody
• SubmitSelfServiceRecoveryFlowWithLinkMethodBody
• SubmitSelfServiceRegistrationFlowBody
• SubmitSelfServiceRegistrationFlowWithOidcMethodBody
• SubmitSelfServiceRegistrationFlowWithPasswordMethodBody
• SubmitSelfServiceRegistrationFlowWithWebAuthnMethodBody
• SubmitSelfServiceSettingsFlowBody
• SubmitSelfServiceSettingsFlowWithLookupMethodBody
• SubmitSelfServiceSettingsFlowWithOidcMethodBody
• SubmitSelfServiceSettingsFlowWithPasswordMethodBody
• SubmitSelfServiceSettingsFlowWithProfileMethodBody
• SubmitSelfServiceSettingsFlowWithTotpMethodBody
• SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody
• SubmitSelfServiceVerificationFlowBody
• SubmitSelfServiceVerificationFlowWithLinkMethodBody
• Subscription
• SuccessfulProjectUpdate
• SuccessfulSelfServiceLoginWithoutBrowser
• SuccessfulSelfServiceRegistrationWithoutBrowser
• TokenPagination
• TokenPaginationHeaders
• TrustJwtGrantIssuerBody
• TrustedJsonWebKey
• TrustedJwtGrantIssuer
• UiContainer
• UiNode
• UiNodeAnchorAttributes
• UiNodeAttributes
• UiNodeImageAttributes
• UiNodeInputAttributes
• UiNodeMeta
• UiNodeScriptAttributes
• UiNodeTextAttributes
• UiText
• UpdateCustomHostnameBody
• UpdateProject
• UpdateSubscriptionPayload
• UserinfoResponse
• VerifiableIdentityAddress
• Version
• Warning
• WellKnown

Documentation For Authorization

basic

• 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 Bearer authentication

Author

[e-mail]