@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
154 lines (153 loc) • 6.99 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.
*/
/**
*
* @export
* @interface JsonWebKey
*/
export interface JsonWebKey {
/**
* The "alg" (algorithm) parameter identifies the algorithm intended for
* use with the key. The values used should either be registered in the
* IANA "JSON Web Signature and Encryption Algorithms" registry
* established by [JWA] or be a value that contains a Collision-
* Resistant Name.
* @type {string}
* @memberof JsonWebKey
*/
alg: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
crv?: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
d?: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
dp?: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
dq?: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
e?: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
k?: string;
/**
* The "kid" (key ID) parameter is used to match a specific key. This
* is used, for instance, to choose among a set of keys within a JWK Set
* during key rollover. The structure of the "kid" value is
* unspecified. When "kid" values are used within a JWK Set, different
* keys within the JWK Set SHOULD use distinct "kid" values. (One
* example in which different keys might use the same "kid" value is if
* they have different "kty" (key type) values but are considered to be
* equivalent alternatives by the application using them.) The "kid"
* value is a case-sensitive string.
* @type {string}
* @memberof JsonWebKey
*/
kid: string;
/**
* The "kty" (key type) parameter identifies the cryptographic algorithm
* family used with the key, such as "RSA" or "EC". "kty" values should
* either be registered in the IANA "JSON Web Key Types" registry
* established by [JWA] or be a value that contains a Collision-
* Resistant Name. The "kty" value is a case-sensitive string.
* @type {string}
* @memberof JsonWebKey
*/
kty: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
n?: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
p?: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
q?: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
qi?: string;
/**
* Use ("public key use") identifies the intended use of
* the public key. The "use" parameter is employed to indicate whether
* a public key is used for encrypting data or verifying the signature
* on data. Values are commonly "sig" (signature) or "enc" (encryption).
* @type {string}
* @memberof JsonWebKey
*/
use: string;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
x?: string;
/**
* The "x5c" (X.509 certificate chain) parameter contains a chain of one
* or more PKIX certificates [RFC5280]. The certificate chain is
* represented as a JSON array of certificate value strings. Each
* string in the array is a base64-encoded (Section 4 of [RFC4648] --
* not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.
* The PKIX certificate containing the key value MUST be the first
* certificate.
* @type {Array<string>}
* @memberof JsonWebKey
*/
x5c?: Array<string>;
/**
*
* @type {string}
* @memberof JsonWebKey
*/
y?: string;
}
/**
* Check if a given object implements the JsonWebKey interface.
*/
export declare function instanceOfJsonWebKey(value: object): value is JsonWebKey;
export declare function JsonWebKeyFromJSON(json: any): JsonWebKey;
export declare function JsonWebKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): JsonWebKey;
export declare function JsonWebKeyToJSON(json: any): JsonWebKey;
export declare function JsonWebKeyToJSONTyped(value?: JsonWebKey | null, ignoreDiscriminator?: boolean): any;