@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
228 lines (227 loc) • 24.3 kB
TypeScript
/**
* Ory APIs
* # Introduction 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. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) |
*
* The version of the OpenAPI document: v1.20.10
* Contact: support@ory.sh
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type { CreateJsonWebKeySet, JsonWebKey, JsonWebKeySet } from '../models/index';
export interface CreateJsonWebKeySetRequest {
set: string;
createJsonWebKeySet: CreateJsonWebKeySet;
}
export interface DeleteJsonWebKeyRequest {
set: string;
kid: string;
}
export interface DeleteJsonWebKeySetRequest {
set: string;
}
export interface GetJsonWebKeyRequest {
set: string;
kid: string;
}
export interface GetJsonWebKeySetRequest {
set: string;
}
export interface SetJsonWebKeyRequest {
set: string;
kid: string;
jsonWebKey?: JsonWebKey;
}
export interface SetJsonWebKeySetRequest {
set: string;
jsonWebKeySet?: JsonWebKeySet;
}
/**
* JwkApi - interface
*
* @export
* @interface JwkApiInterface
*/
export interface JwkApiInterface {
/**
* This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* @summary Create JSON Web Key
* @param {string} set The JSON Web Key Set ID
* @param {CreateJsonWebKeySet} createJsonWebKeySet
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JwkApiInterface
*/
createJsonWebKeySetRaw(requestParameters: CreateJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKeySet>>;
/**
* This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Create JSON Web Key
*/
createJsonWebKeySet(requestParameters: CreateJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKeySet>;
/**
* Use this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* @summary Delete JSON Web Key
* @param {string} set The JSON Web Key Set
* @param {string} kid The JSON Web Key ID (kid)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JwkApiInterface
*/
deleteJsonWebKeyRaw(requestParameters: DeleteJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Use this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Delete JSON Web Key
*/
deleteJsonWebKey(requestParameters: DeleteJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* @summary Delete JSON Web Key Set
* @param {string} set The JSON Web Key Set
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JwkApiInterface
*/
deleteJsonWebKeySetRaw(requestParameters: DeleteJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Delete JSON Web Key Set
*/
deleteJsonWebKeySet(requestParameters: DeleteJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid).
* @summary Get JSON Web Key
* @param {string} set JSON Web Key Set ID
* @param {string} kid JSON Web Key ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JwkApiInterface
*/
getJsonWebKeyRaw(requestParameters: GetJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKeySet>>;
/**
* This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid).
* Get JSON Web Key
*/
getJsonWebKey(requestParameters: GetJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKeySet>;
/**
* This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* @summary Retrieve a JSON Web Key Set
* @param {string} set JSON Web Key Set ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JwkApiInterface
*/
getJsonWebKeySetRaw(requestParameters: GetJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKeySet>>;
/**
* This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Retrieve a JSON Web Key Set
*/
getJsonWebKeySet(requestParameters: GetJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKeySet>;
/**
* Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* @summary Set JSON Web Key
* @param {string} set The JSON Web Key Set ID
* @param {string} kid JSON Web Key ID
* @param {JsonWebKey} [jsonWebKey]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JwkApiInterface
*/
setJsonWebKeyRaw(requestParameters: SetJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKey>>;
/**
* Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Set JSON Web Key
*/
setJsonWebKey(requestParameters: SetJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKey>;
/**
* Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* @summary Update a JSON Web Key Set
* @param {string} set The JSON Web Key Set ID
* @param {JsonWebKeySet} [jsonWebKeySet]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JwkApiInterface
*/
setJsonWebKeySetRaw(requestParameters: SetJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKeySet>>;
/**
* Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Update a JSON Web Key Set
*/
setJsonWebKeySet(requestParameters: SetJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKeySet>;
}
/**
*
*/
export declare class JwkApi extends runtime.BaseAPI implements JwkApiInterface {
/**
* This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Create JSON Web Key
*/
createJsonWebKeySetRaw(requestParameters: CreateJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKeySet>>;
/**
* This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Create JSON Web Key
*/
createJsonWebKeySet(requestParameters: CreateJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKeySet>;
/**
* Use this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Delete JSON Web Key
*/
deleteJsonWebKeyRaw(requestParameters: DeleteJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Use this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Delete JSON Web Key
*/
deleteJsonWebKey(requestParameters: DeleteJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Delete JSON Web Key Set
*/
deleteJsonWebKeySetRaw(requestParameters: DeleteJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Delete JSON Web Key Set
*/
deleteJsonWebKeySet(requestParameters: DeleteJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid).
* Get JSON Web Key
*/
getJsonWebKeyRaw(requestParameters: GetJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKeySet>>;
/**
* This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid).
* Get JSON Web Key
*/
getJsonWebKey(requestParameters: GetJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKeySet>;
/**
* This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Retrieve a JSON Web Key Set
*/
getJsonWebKeySetRaw(requestParameters: GetJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKeySet>>;
/**
* This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Retrieve a JSON Web Key Set
*/
getJsonWebKeySet(requestParameters: GetJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKeySet>;
/**
* Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Set JSON Web Key
*/
setJsonWebKeyRaw(requestParameters: SetJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKey>>;
/**
* Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Set JSON Web Key
*/
setJsonWebKey(requestParameters: SetJsonWebKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKey>;
/**
* Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Update a JSON Web Key Set
*/
setJsonWebKeySetRaw(requestParameters: SetJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JsonWebKeySet>>;
/**
* Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
* Update a JSON Web Key Set
*/
setJsonWebKeySet(requestParameters: SetJsonWebKeySetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonWebKeySet>;
}