@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
512 lines • 42 kB
TypeScript
import { CreateProjectApiKeyRequest, CreateProjectBody, GetOrganizationResponse, JsonPatch, ListOrganizationsResponse, Organization, OrganizationBody, Project, ProjectApiKey, ProjectMember, ProjectMetadata, SetProject, SuccessfulProjectUpdate } from '../models/index';
/**
* 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';
export interface CreateOrganizationRequest {
projectId: string;
organizationBody?: OrganizationBody;
}
export interface CreateProjectRequest {
createProjectBody?: CreateProjectBody;
}
export interface CreateProjectApiKeyOperationRequest {
project: string;
createProjectApiKeyRequest?: CreateProjectApiKeyRequest;
}
export interface DeleteOrganizationRequest {
projectId: string;
organizationId: string;
}
export interface DeleteProjectApiKeyRequest {
project: string;
tokenId: string;
}
export interface GetOrganizationRequest {
projectId: string;
organizationId: string;
}
export interface GetProjectRequest {
projectId: string;
}
export interface GetProjectMembersRequest {
project: string;
}
export interface ListOrganizationsRequest {
projectId: string;
pageSize?: number;
pageToken?: string;
domain?: string;
}
export interface ListProjectApiKeysRequest {
project: string;
}
export interface PatchProjectRequest {
projectId: string;
jsonPatch?: Array<JsonPatch>;
}
export interface PatchProjectWithRevisionRequest {
projectId: string;
revisionId: string;
jsonPatch?: Array<JsonPatch>;
}
export interface PurgeProjectRequest {
projectId: string;
}
export interface RemoveProjectMemberRequest {
project: string;
member: string;
}
export interface SetProjectRequest {
projectId: string;
setProject?: SetProject;
}
export interface UpdateOrganizationRequest {
projectId: string;
organizationId: string;
organizationBody?: OrganizationBody;
}
/**
* ProjectApi - interface
*
* @export
* @interface ProjectApiInterface
*/
export interface ProjectApiInterface {
/**
* Creates an Enterprise SSO Organization in a project.
* @summary Create an Enterprise SSO Organization
* @param {string} projectId Project ID The project\'s ID.
* @param {OrganizationBody} [organizationBody]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
createOrganizationRaw(requestParameters: CreateOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Organization>>;
/**
* Creates an Enterprise SSO Organization in a project.
* Create an Enterprise SSO Organization
*/
createOrganization(requestParameters: CreateOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Organization>;
/**
* Creates a new project.
* @summary Create a Project
* @param {CreateProjectBody} [createProjectBody]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
createProjectRaw(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
/**
* Creates a new project.
* Create a Project
*/
createProject(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
/**
* Create an API key for a project.
* @summary Create project API key
* @param {string} project The Project ID or Project slug
* @param {CreateProjectApiKeyRequest} [createProjectApiKeyRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
createProjectApiKeyRaw(requestParameters: CreateProjectApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectApiKey>>;
/**
* Create an API key for a project.
* Create project API key
*/
createProjectApiKey(requestParameters: CreateProjectApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectApiKey>;
/**
* Irrecoverably deletes an Enterprise SSO Organization in a project by its ID.
* @summary Delete Enterprise SSO Organization
* @param {string} projectId Project ID The project\'s ID.
* @param {string} organizationId Organization ID The Organization\'s ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
deleteOrganizationRaw(requestParameters: DeleteOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Irrecoverably deletes an Enterprise SSO Organization in a project by its ID.
* Delete Enterprise SSO Organization
*/
deleteOrganization(requestParameters: DeleteOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Deletes an API key and immediately removes it.
* @summary Delete project API key
* @param {string} project The Project ID or Project slug
* @param {string} tokenId The Token ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
deleteProjectApiKeyRaw(requestParameters: DeleteProjectApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Deletes an API key and immediately removes it.
* Delete project API key
*/
deleteProjectApiKey(requestParameters: DeleteProjectApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Retrieves an Enterprise SSO Organization for a project by its ID
* @summary Get Enterprise SSO Organization by ID
* @param {string} projectId Project ID The project\'s ID.
* @param {string} organizationId Organization ID The Organization\'s ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
getOrganizationRaw(requestParameters: GetOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrganizationResponse>>;
/**
* Retrieves an Enterprise SSO Organization for a project by its ID
* Get Enterprise SSO Organization by ID
*/
getOrganization(requestParameters: GetOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrganizationResponse>;
/**
* Get a projects you have access to by its ID.
* @summary Get a Project
* @param {string} projectId Project ID The project\'s ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
/**
* Get a projects you have access to by its ID.
* Get a Project
*/
getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
/**
* This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
* @summary Get all members associated with this project
* @param {string} project
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
getProjectMembersRaw(requestParameters: GetProjectMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectMember>>>;
/**
* This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
* Get all members associated with this project
*/
getProjectMembers(requestParameters: GetProjectMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectMember>>;
/**
* Lists all Enterprise SSO organizations in a project.
* @summary List all Enterprise SSO organizations
* @param {string} projectId Project ID The project\'s ID.
* @param {number} [pageSize] Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
* @param {string} [pageToken] Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
* @param {string} [domain] Domain If set, only organizations with that domain will be returned.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
listOrganizationsRaw(requestParameters: ListOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrganizationsResponse>>;
/**
* Lists all Enterprise SSO organizations in a project.
* List all Enterprise SSO organizations
*/
listOrganizations(requestParameters: ListOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrganizationsResponse>;
/**
* A list of all the project\'s API keys.
* @summary List a project\'s API keys
* @param {string} project The Project ID or Project slug
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
listProjectApiKeysRaw(requestParameters: ListProjectApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectApiKey>>>;
/**
* A list of all the project\'s API keys.
* List a project\'s API keys
*/
listProjectApiKeys(requestParameters: ListProjectApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectApiKey>>;
/**
* Lists all projects you have access to.
* @summary List All Projects
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
listProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectMetadata>>>;
/**
* Lists all projects you have access to.
* List All Projects
*/
listProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectMetadata>>;
/**
* Deprecated: Use the `patchProjectWithRevision` endpoint instead to specify the exact revision the patch was generated for. This endpoints allows you to patch individual Ory Network project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
* @summary Patch an Ory Network Project Configuration
* @param {string} projectId Project ID The project\'s ID.
* @param {Array<JsonPatch>} [jsonPatch]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
patchProjectRaw(requestParameters: PatchProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessfulProjectUpdate>>;
/**
* Deprecated: Use the `patchProjectWithRevision` endpoint instead to specify the exact revision the patch was generated for. This endpoints allows you to patch individual Ory Network project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
* Patch an Ory Network Project Configuration
*/
patchProject(requestParameters: PatchProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessfulProjectUpdate>;
/**
* This endpoints allows you to patch individual Ory Network Project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
* @summary Patch an Ory Network Project Configuration based on a revision ID
* @param {string} projectId Project ID The project\'s ID.
* @param {string} revisionId Revision ID The revision ID that this patch was generated for.
* @param {Array<JsonPatch>} [jsonPatch]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
patchProjectWithRevisionRaw(requestParameters: PatchProjectWithRevisionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessfulProjectUpdate>>;
/**
* This endpoints allows you to patch individual Ory Network Project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
* Patch an Ory Network Project Configuration based on a revision ID
*/
patchProjectWithRevision(requestParameters: PatchProjectWithRevisionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessfulProjectUpdate>;
/**
* !! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. Calling this endpoint will additionally delete custom domains and other related data. If the project is linked to a subscription, the subscription needs to be unlinked first.
* @summary Irrecoverably purge a project
* @param {string} projectId Project ID The project\'s ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
purgeProjectRaw(requestParameters: PurgeProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* !! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. Calling this endpoint will additionally delete custom domains and other related data. If the project is linked to a subscription, the subscription needs to be unlinked first.
* Irrecoverably purge a project
*/
purgeProject(requestParameters: PurgeProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* This also sets their invite status to `REMOVED`. This endpoint requires the user to be a member of the project with the role `OWNER`.
* @summary Remove a member associated with this project
* @param {string} project
* @param {string} member
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
removeProjectMemberRaw(requestParameters: RemoveProjectMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* This also sets their invite status to `REMOVED`. This endpoint requires the user to be a member of the project with the role `OWNER`.
* Remove a member associated with this project
*/
removeProjectMember(requestParameters: RemoveProjectMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* This endpoints allows you to update the Ory Network project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service\'s configuration will completely override your current configuration for that service!
* @summary Update an Ory Network Project Configuration
* @param {string} projectId Project ID The project\'s ID.
* @param {SetProject} [setProject]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
setProjectRaw(requestParameters: SetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessfulProjectUpdate>>;
/**
* This endpoints allows you to update the Ory Network project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service\'s configuration will completely override your current configuration for that service!
* Update an Ory Network Project Configuration
*/
setProject(requestParameters: SetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessfulProjectUpdate>;
/**
* Updates an Enterprise SSO Organization in a project by its ID.
* @summary Update an Enterprise SSO Organization
* @param {string} projectId Project ID The project\'s ID.
* @param {string} organizationId Organization ID The Organization\'s ID.
* @param {OrganizationBody} [organizationBody]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProjectApiInterface
*/
updateOrganizationRaw(requestParameters: UpdateOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Organization>>;
/**
* Updates an Enterprise SSO Organization in a project by its ID.
* Update an Enterprise SSO Organization
*/
updateOrganization(requestParameters: UpdateOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Organization>;
}
/**
*
*/
export declare class ProjectApi extends runtime.BaseAPI implements ProjectApiInterface {
/**
* Creates an Enterprise SSO Organization in a project.
* Create an Enterprise SSO Organization
*/
createOrganizationRaw(requestParameters: CreateOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Organization>>;
/**
* Creates an Enterprise SSO Organization in a project.
* Create an Enterprise SSO Organization
*/
createOrganization(requestParameters: CreateOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Organization>;
/**
* Creates a new project.
* Create a Project
*/
createProjectRaw(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
/**
* Creates a new project.
* Create a Project
*/
createProject(requestParameters?: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
/**
* Create an API key for a project.
* Create project API key
*/
createProjectApiKeyRaw(requestParameters: CreateProjectApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectApiKey>>;
/**
* Create an API key for a project.
* Create project API key
*/
createProjectApiKey(requestParameters: CreateProjectApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectApiKey>;
/**
* Irrecoverably deletes an Enterprise SSO Organization in a project by its ID.
* Delete Enterprise SSO Organization
*/
deleteOrganizationRaw(requestParameters: DeleteOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Irrecoverably deletes an Enterprise SSO Organization in a project by its ID.
* Delete Enterprise SSO Organization
*/
deleteOrganization(requestParameters: DeleteOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Deletes an API key and immediately removes it.
* Delete project API key
*/
deleteProjectApiKeyRaw(requestParameters: DeleteProjectApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Deletes an API key and immediately removes it.
* Delete project API key
*/
deleteProjectApiKey(requestParameters: DeleteProjectApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Retrieves an Enterprise SSO Organization for a project by its ID
* Get Enterprise SSO Organization by ID
*/
getOrganizationRaw(requestParameters: GetOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrganizationResponse>>;
/**
* Retrieves an Enterprise SSO Organization for a project by its ID
* Get Enterprise SSO Organization by ID
*/
getOrganization(requestParameters: GetOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrganizationResponse>;
/**
* Get a projects you have access to by its ID.
* Get a Project
*/
getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
/**
* Get a projects you have access to by its ID.
* Get a Project
*/
getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
/**
* This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
* Get all members associated with this project
*/
getProjectMembersRaw(requestParameters: GetProjectMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectMember>>>;
/**
* This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
* Get all members associated with this project
*/
getProjectMembers(requestParameters: GetProjectMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectMember>>;
/**
* Lists all Enterprise SSO organizations in a project.
* List all Enterprise SSO organizations
*/
listOrganizationsRaw(requestParameters: ListOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrganizationsResponse>>;
/**
* Lists all Enterprise SSO organizations in a project.
* List all Enterprise SSO organizations
*/
listOrganizations(requestParameters: ListOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrganizationsResponse>;
/**
* A list of all the project\'s API keys.
* List a project\'s API keys
*/
listProjectApiKeysRaw(requestParameters: ListProjectApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectApiKey>>>;
/**
* A list of all the project\'s API keys.
* List a project\'s API keys
*/
listProjectApiKeys(requestParameters: ListProjectApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectApiKey>>;
/**
* Lists all projects you have access to.
* List All Projects
*/
listProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectMetadata>>>;
/**
* Lists all projects you have access to.
* List All Projects
*/
listProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectMetadata>>;
/**
* Deprecated: Use the `patchProjectWithRevision` endpoint instead to specify the exact revision the patch was generated for. This endpoints allows you to patch individual Ory Network project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
* Patch an Ory Network Project Configuration
*/
patchProjectRaw(requestParameters: PatchProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessfulProjectUpdate>>;
/**
* Deprecated: Use the `patchProjectWithRevision` endpoint instead to specify the exact revision the patch was generated for. This endpoints allows you to patch individual Ory Network project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
* Patch an Ory Network Project Configuration
*/
patchProject(requestParameters: PatchProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessfulProjectUpdate>;
/**
* This endpoints allows you to patch individual Ory Network Project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
* Patch an Ory Network Project Configuration based on a revision ID
*/
patchProjectWithRevisionRaw(requestParameters: PatchProjectWithRevisionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessfulProjectUpdate>>;
/**
* This endpoints allows you to patch individual Ory Network Project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
* Patch an Ory Network Project Configuration based on a revision ID
*/
patchProjectWithRevision(requestParameters: PatchProjectWithRevisionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessfulProjectUpdate>;
/**
* !! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. Calling this endpoint will additionally delete custom domains and other related data. If the project is linked to a subscription, the subscription needs to be unlinked first.
* Irrecoverably purge a project
*/
purgeProjectRaw(requestParameters: PurgeProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* !! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. Calling this endpoint will additionally delete custom domains and other related data. If the project is linked to a subscription, the subscription needs to be unlinked first.
* Irrecoverably purge a project
*/
purgeProject(requestParameters: PurgeProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* This also sets their invite status to `REMOVED`. This endpoint requires the user to be a member of the project with the role `OWNER`.
* Remove a member associated with this project
*/
removeProjectMemberRaw(requestParameters: RemoveProjectMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* This also sets their invite status to `REMOVED`. This endpoint requires the user to be a member of the project with the role `OWNER`.
* Remove a member associated with this project
*/
removeProjectMember(requestParameters: RemoveProjectMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* This endpoints allows you to update the Ory Network project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service\'s configuration will completely override your current configuration for that service!
* Update an Ory Network Project Configuration
*/
setProjectRaw(requestParameters: SetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessfulProjectUpdate>>;
/**
* This endpoints allows you to update the Ory Network project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service\'s configuration will completely override your current configuration for that service!
* Update an Ory Network Project Configuration
*/
setProject(requestParameters: SetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessfulProjectUpdate>;
/**
* Updates an Enterprise SSO Organization in a project by its ID.
* Update an Enterprise SSO Organization
*/
updateOrganizationRaw(requestParameters: UpdateOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Organization>>;
/**
* Updates an Enterprise SSO Organization in a project by its ID.
* Update an Enterprise SSO Organization
*/
updateOrganization(requestParameters: UpdateOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Organization>;
}
//# sourceMappingURL=ProjectApi.d.ts.map