@affinidi/cli 1.66.0 → 2.0.0-beta.10

package/dist/services/affinidi/iam/iam.api.d.ts

@@ -0,0 +1,455 @@
+export interface ServiceErrorResponse {
+    /**
+     * unique id for correlating this specific error to logs
+     * @format uuid
+     */
+    debugId: string;
+    /** name of the error */
+    name: string;
+    /** backwards compatible Affinidi error code */
+    code: string;
+    details?: {
+        issue: string;
+        field?: string;
+        value?: string;
+        location?: string;
+    }[];
+}
+export interface UserDto {
+    principalId: string;
+}
+export interface TypedPricipalId {
+    principalId: string;
+}
+export interface AddUserToProjectInput {
+    principalId: string;
+    principalType: string;
+}
+export interface CreateProjectScopedTokenInput {
+    projectId: string;
+}
+export interface CreateProjectScopedTokenOutput {
+    accessToken: string;
+    expiresIn: number;
+    scope: string;
+}
+export interface ProjectDto {
+    id: string;
+    name: string;
+    description?: string;
+    /** creation date and time in ISO-8601 format, e.g. 2023-09-20T07:12:13 */
+    createdAt?: string;
+}
+export interface CreateProjectInput {
+    name: string;
+    description?: string;
+}
+export interface ProjectList {
+    projects: ProjectDto[];
+}
+export interface UserList {
+    records: UserDto[];
+}
+export interface PolicyStatementDto {
+    action: string[];
+    effect: string;
+    principal: string[];
+    resource: string[];
+}
+export interface WhoamiDto {
+    principalId: string;
+    principalType: string;
+}
+export interface PolicyDto {
+    principalId?: string;
+    projectId?: string;
+    version: string;
+    statement: PolicyStatementDto[];
+}
+export interface JsonWebKeyDto {
+    kid: string;
+    kty: string;
+    n?: string;
+    e?: string;
+    alg: string;
+    use: string;
+}
+export interface JsonWebKeySetDto {
+    /** @minItems 1 */
+    keys: JsonWebKeyDto[];
+}
+/**
+ * Private Key JWT Authentication of Client with `private_key_jwt` oAuth Method
+ * @example "{"type": "PRIVATE_KEY", "signingAlgorithm": "RS256", "publicKeyInfo": { "jwks": {"keys":[{"use":"sig","kty":"RSA","kid":"some-kid","alg":"RS256","n":"some-n-value","e":"some-e-value"}]} }}"
+ */
+export interface MachineUserPrivateKeyAuthenticationMethodDto {
+    type: 'PRIVATE_KEY';
+    signingAlgorithm: 'RS256' | 'RS512' | 'ES256' | 'ES512';
+    /** Corresponding Public Key Info provided either as a URL or a Hardcoded Object */
+    publicKeyInfo: {
+        jwks: JsonWebKeySetDto;
+    } | {
+        /** @format url */
+        jwksUri: string;
+    };
+}
+/** How the Machine User will be authenticate against our Authorization Server */
+export type MachineUserAuthenticationMethodDto = MachineUserPrivateKeyAuthenticationMethodDto;
+export interface MachineUserDto {
+    /**
+     * MachineUser Id
+     * @format uuid
+     * @example "c5817ea6-8367-4458-9131-54cd2c5b9b48"
+     */
+    id: string;
+    /**
+     * MachineUser ARI
+     * @example "machine/c5817ea6-8367-4458-9131-54cd2c5b9b48"
+     */
+    ari: string;
+    /**
+     * The MachineUser owner's ARI
+     * @example "ari:iam:::user/2f4b3468-516f-4af3-87db-8816b0d320cc"
+     */
+    ownerAri: string;
+    /**
+     * Owner defined MachineUser display name
+     * @example "AIV/Concierge API - affinidi-elements-iam-dev"
+     */
+    name: string;
+    /** How the Machine User will be authenticate against our Authorization Server */
+    authenticationMethod: MachineUserAuthenticationMethodDto;
+    /** Scopes that will be assigned to the MachineUser on authentication */
+    scopes: string[];
+}
+export interface MachineUserList {
+    machineUsers: MachineUserDto[];
+}
+export interface CreateMachineUserInput {
+    /** @example "AIV/Concierge API - affinidi-elements-iam-dev" */
+    name: string;
+    /** How the Machine User will be authenticate against our Authorization Server */
+    authenticationMethod: MachineUserAuthenticationMethodDto;
+}
+export interface UpdateMachineUserInput {
+    /** @example "AIV/Concierge API - affinidi-elements-iam-dev" */
+    name: string;
+    /** How the Machine User will be authenticate against our Authorization Server */
+    authenticationMethod: MachineUserAuthenticationMethodDto;
+}
+export interface UnexpectedError {
+    name: 'UnexpectedError';
+    message: 'Unexpected Error Occurred.';
+    httpStatusCode: 500;
+    traceId: string;
+    details?: {
+        issue: string;
+        field?: string;
+        value?: string;
+        location?: string;
+    }[];
+}
+export interface InvalidParameterError {
+    name: 'InvalidParameterError';
+    message: 'Invalid parameter: ${param}.';
+    httpStatusCode: 400;
+    traceId: string;
+    details?: {
+        issue: string;
+        field?: string;
+        value?: string;
+        location?: string;
+    }[];
+}
+export interface NotFoundError {
+    name: 'NotFoundError';
+    message: 'Not found: ${param}.';
+    httpStatusCode: 404;
+    traceId: string;
+    details?: {
+        issue: string;
+        field?: string;
+        value?: string;
+        location?: string;
+    }[];
+}
+export interface PrincipalDoesNotBelongToProjectError {
+    name: 'PrincipalDoesNotBelongToProjectError';
+    message: 'Principal does not belong to the given project';
+    httpStatusCode: 403;
+    traceId: string;
+    details?: {
+        issue: string;
+        field?: string;
+        value?: string;
+        location?: string;
+    }[];
+}
+export interface ActionForbiddenError {
+    name: 'ActionForbiddenError';
+    message: 'Principal can not execute action on given resource';
+    httpStatusCode: 403;
+    traceId: string;
+    details?: {
+        issue: string;
+        field?: string;
+        value?: string;
+        location?: string;
+    }[];
+}
+import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
+export type QueryParamsType = Record<string | number, any>;
+export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
+    /** set parameter to `true` for call `securityWorker` for this request */
+    secure?: boolean;
+    /** request path */
+    path: string;
+    /** content type of request body */
+    type?: ContentType;
+    /** query params */
+    query?: QueryParamsType;
+    /** format of response (i.e. response.json() -> format: "json") */
+    format?: ResponseType;
+    /** request body */
+    body?: unknown;
+}
+export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
+    securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
+    secure?: boolean;
+    format?: ResponseType;
+}
+export declare enum ContentType {
+    Json = "application/json",
+    FormData = "multipart/form-data",
+    UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain"
+}
+export declare class HttpClient<SecurityDataType = unknown> {
+    instance: AxiosInstance;
+    private securityData;
+    private securityWorker?;
+    private secure?;
+    private format?;
+    constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
+    setSecurityData: (data: SecurityDataType | null) => void;
+    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
+    protected stringifyFormItem(formItem: unknown): string;
+    protected createFormData(input: Record<string, unknown>): FormData;
+    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<axios.AxiosResponse<T, any>>;
+}
+/**
+ * @title Iam
+ * @version 1.0.0
+ * @baseUrl /
+ * @contact nucleus <nucleus.team@affinidi.com>
+ *
+ * Affinidi IAM
+ */
+export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
+    wellKnown: {
+        /**
+         * No description
+         *
+         * @tags well-known
+         * @name GetWellKnownJwks
+         * @request GET:/.well-known/jwks.json
+         */
+        getWellKnownJwks: (params?: RequestParams) => Promise<axios.AxiosResponse<JsonWebKeySetDto, any>>;
+    };
+    v1: {
+        /**
+         * @description This is deprecated endpoint, please use /v1/sts/create-project-scoped-token
+         *
+         * @tags sts
+         * @name DeprecatedCreateProjectScopedToken
+         * @request POST:/v1/create-project-scoped-token
+         * @deprecated
+         * @secure
+         */
+        deprecatedCreateProjectScopedToken: (data: CreateProjectScopedTokenInput, params?: RequestParams) => Promise<axios.AxiosResponse<CreateProjectScopedTokenOutput, any>>;
+        /**
+         * No description
+         *
+         * @tags sts
+         * @name CreateProjectScopedToken
+         * @request POST:/v1/sts/create-project-scoped-token
+         * @secure
+         */
+        createProjectScopedToken: (data: CreateProjectScopedTokenInput, params?: RequestParams) => Promise<axios.AxiosResponse<CreateProjectScopedTokenOutput, any>>;
+        /**
+         * No description
+         *
+         * @tags sts
+         * @name Whoami
+         * @request GET:/v1/sts/whoami
+         * @secure
+         */
+        whoami: (params?: RequestParams) => Promise<axios.AxiosResponse<WhoamiDto, any>>;
+        /**
+         * No description
+         *
+         * @tags projects
+         * @name CreateProject
+         * @request POST:/v1/projects
+         * @secure
+         */
+        createProject: (data: CreateProjectInput, params?: RequestParams) => Promise<axios.AxiosResponse<ProjectDto, any>>;
+        /**
+         * No description
+         *
+         * @tags projects
+         * @name ListProject
+         * @request GET:/v1/projects
+         * @secure
+         */
+        listProject: (params?: RequestParams) => Promise<axios.AxiosResponse<ProjectList, any>>;
+        /**
+         * No description
+         *
+         * @tags projects
+         * @name AddUserToProject
+         * @request POST:/v1/projects/users
+         * @deprecated
+         * @secure
+         */
+        addUserToProject: (data: AddUserToProjectInput, params?: RequestParams) => Promise<axios.AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags projects
+         * @name ListUsersOfProject
+         * @request GET:/v1/projects/users
+         * @deprecated
+         * @secure
+         */
+        listUsersOfProject: (params?: RequestParams) => Promise<axios.AxiosResponse<UserList, any>>;
+        /**
+         * No description
+         *
+         * @tags projects
+         * @name DeleteUserFromProject
+         * @request DELETE:/v1/projects/users/{userId}
+         * @deprecated
+         * @secure
+         */
+        deleteUserFromProject: (userId: string, params?: RequestParams) => Promise<axios.AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags projects
+         * @name ListPrincipalsOfProject
+         * @request GET:/v1/projects/principals
+         * @secure
+         */
+        listPrincipalsOfProject: (params?: RequestParams) => Promise<axios.AxiosResponse<UserList, any>>;
+        /**
+         * No description
+         *
+         * @tags projects
+         * @name AddPrincipalToProject
+         * @request POST:/v1/projects/principals
+         * @secure
+         */
+        addPrincipalToProject: (data: AddUserToProjectInput, params?: RequestParams) => Promise<axios.AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags projects
+         * @name DeletePrincipalFromProject
+         * @request DELETE:/v1/projects/principals/{principalId}
+         * @secure
+         */
+        deletePrincipalFromProject: (principalId: string, query: {
+            /** type of principal */
+            principalType: 'user' | 'machine_user';
+        }, params?: RequestParams) => Promise<axios.AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags policies
+         * @name DeprecatedGetPolicies
+         * @request GET:/v1/policies/users/{userId}
+         * @deprecated
+         * @secure
+         */
+        deprecatedGetPolicies: (userId: string, params?: RequestParams) => Promise<axios.AxiosResponse<PolicyDto, any>>;
+        /**
+         * No description
+         *
+         * @tags policies
+         * @name DeprecatedUpdatePolicies
+         * @request PUT:/v1/policies/users/{userId}
+         * @deprecated
+         * @secure
+         */
+        deprecatedUpdatePolicies: (userId: string, data: PolicyDto, params?: RequestParams) => Promise<axios.AxiosResponse<PolicyDto, any>>;
+        /**
+         * No description
+         *
+         * @tags policies
+         * @name GetPolicies
+         * @request GET:/v1/policies/principals/{principalId}
+         * @secure
+         */
+        getPolicies: (principalId: string, query: {
+            principalType: 'user' | 'machine_user';
+        }, params?: RequestParams) => Promise<axios.AxiosResponse<PolicyDto, any>>;
+        /**
+         * No description
+         *
+         * @tags policies
+         * @name UpdatePolicies
+         * @request PUT:/v1/policies/principals/{principalId}
+         * @secure
+         */
+        updatePolicies: (principalId: string, query: {
+            principalType: 'user' | 'machine_user';
+        }, data: PolicyDto, params?: RequestParams) => Promise<axios.AxiosResponse<PolicyDto, any>>;
+        /**
+         * No description
+         *
+         * @tags machine-users
+         * @name CreateMachineUser
+         * @request POST:/v1/machine-users
+         * @secure
+         */
+        createMachineUser: (data: CreateMachineUserInput, params?: RequestParams) => Promise<axios.AxiosResponse<MachineUserDto, any>>;
+        /**
+         * No description
+         *
+         * @tags machine-users
+         * @name ListMachineUser
+         * @request GET:/v1/machine-users
+         * @secure
+         */
+        listMachineUser: (params?: RequestParams) => Promise<axios.AxiosResponse<MachineUserList, any>>;
+        /**
+         * No description
+         *
+         * @tags machine-users
+         * @name GetMachineUser
+         * @request GET:/v1/machine-users/{machineUserId}
+         * @secure
+         */
+        getMachineUser: (machineUserId: string, params?: RequestParams) => Promise<axios.AxiosResponse<MachineUserDto, any>>;
+        /**
+         * No description
+         *
+         * @tags machine-users
+         * @name UpdateMachineUser
+         * @request PATCH:/v1/machine-users/{machineUserId}
+         * @secure
+         */
+        updateMachineUser: (machineUserId: string, data: UpdateMachineUserInput, params?: RequestParams) => Promise<axios.AxiosResponse<MachineUserDto, any>>;
+        /**
+         * No description
+         *
+         * @tags machine-users
+         * @name DeleteMachineUser
+         * @request DELETE:/v1/machine-users/{machineUserId}
+         * @secure
+         */
+        deleteMachineUser: (machineUserId: string, params?: RequestParams) => Promise<axios.AxiosResponse<void, any>>;
+    };
+}