jira.js
    Preparing search index...

    Function createUserManagementClient

    • Parameters

      Returns {
          apiTokens: {
              deleteApiToken: (
                  parameters: { accountId: string; tokenId: string },
                  options?: RequestOptions,
              ) => Promise<void>;
              getApiTokens: (
                  parameters: { accountId: string },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      createdAt: string;
                      expiry?: string;
                      id: string;
                      label: string;
                      lastAccess?: string;
                      [key: string]: unknown;
                  }[],
              >;
          };
          email: {
              setEmail: (
                  parameters: { accountId: string; email: string },
                  options?: RequestOptions,
              ) => Promise<void>;
          };
          lifecycle: {
              activateUser: (
                  parameters: { accountId: string },
                  options?: RequestOptions,
              ) => Promise<void>;
              cancelAccountDeletion: (
                  parameters: { accountId: string },
                  options?: RequestOptions,
              ) => Promise<void>;
              deactivateUser: (
                  parameters: { accountId: string; message?: string },
                  options?: RequestOptions,
              ) => Promise<void>;
              deleteAccount: (
                  parameters: { accountId: string },
                  options?: RequestOptions,
              ) => Promise<void>;
          };
          manage: {
              getManagementPermissions: (
                  parameters: {
                      accountId: string;
                      privileges?: (
                          | string & {}
                          | "profile"
                          | "profile.write"
                          | "profile.read"
                          | "email.set"
                          | "lifecycle.enablement"
                          | "lifecycle.delete"
                          | "apiToken.read"
                          | "apiToken.delete"
                      )[];
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      "apiToken.delete"?: | { allowed: true; [key: string]: unknown }
                      | {
                          allowed: false;
                          reason: {
                              key:
                                  | string & {}
                                  | "administrative"
                                  | "administrative.notMyself"
                                  | "authPolicy.saml"
                                  | "blocked.exportControl"
                                  | "externalDirectory.scim"
                                  | "externalDirectory.google"
                                  | "myselfOnly"
                                  | "managedAccount";
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      "apiToken.read"?: | { allowed: true; [key: string]: unknown }
                      | {
                          allowed: false;
                          reason: {
                              key:
                                  | string & {}
                                  | "administrative"
                                  | "administrative.notMyself"
                                  | "authPolicy.saml"
                                  | "blocked.exportControl"
                                  | "externalDirectory.scim"
                                  | "externalDirectory.google"
                                  | "myselfOnly"
                                  | "managedAccount";
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      "email.set"?: | { allowed: true; [key: string]: unknown }
                      | {
                          allowed: false;
                          reason: {
                              key:
                                  | string & {}
                                  | "administrative"
                                  | "administrative.notMyself"
                                  | "authPolicy.saml"
                                  | "blocked.exportControl"
                                  | "externalDirectory.scim"
                                  | "externalDirectory.google"
                                  | "myselfOnly"
                                  | "managedAccount";
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      "lifecycle.delete"?: | { allowed: true; [key: string]: unknown }
                      | {
                          allowed: false;
                          reason: {
                              key:
                                  | string & {}
                                  | "administrative"
                                  | "administrative.notMyself"
                                  | "authPolicy.saml"
                                  | "blocked.exportControl"
                                  | "externalDirectory.scim"
                                  | "externalDirectory.google"
                                  | "myselfOnly"
                                  | "managedAccount";
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      "lifecycle.enablement"?: | { allowed: true; [key: string]: unknown }
                      | {
                          allowed: false;
                          reason: {
                              key:
                                  | string & {}
                                  | "administrative"
                                  | "administrative.notMyself"
                                  | "authPolicy.saml"
                                  | "blocked.exportControl"
                                  | "externalDirectory.scim"
                                  | "externalDirectory.google"
                                  | "myselfOnly"
                                  | "managedAccount";
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      profile?: Record<
                          string,
                          | { allowed: true; [key: string]: unknown }
                          | {
                              allowed: false;
                              reason: {
                                  key:
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                                  [key: string]: unknown;
                              };
                              [key: string]: unknown;
                          },
                      >;
                      "profile.read"?: | { allowed: true; [key: string]: unknown }
                      | {
                          allowed: false;
                          reason: {
                              key:
                                  | string & {}
                                  | "administrative"
                                  | "administrative.notMyself"
                                  | "authPolicy.saml"
                                  | "blocked.exportControl"
                                  | "externalDirectory.scim"
                                  | "externalDirectory.google"
                                  | "myselfOnly"
                                  | "managedAccount";
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      "profile.write"?: Record<
                          string,
                          | { allowed: true; [key: string]: unknown }
                          | {
                              allowed: false;
                              reason: {
                                  key:
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                                  [key: string]: unknown;
                              };
                              [key: string]: unknown;
                          },
                      >;
                      [key: string]: unknown;
                  },
              >;
          };
          profile: {
              getProfile: (
                  parameters: { accountId: string },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      account: {
                          account_id: string;
                          account_status: "active"
                          | "inactive"
                          | "closed"
                          | string & {};
                          account_type: string & {} | "atlassian" | "app" | "customer";
                          characteristics?: { not_mentionable?: boolean; [key: string]: unknown };
                          email: string;
                          extended_profile?: {
                              department?: string;
                              job_title?: string;
                              location?: string;
                              organization?: string;
                              [key: string]: unknown;
                          };
                          locale?: string;
                          name: string;
                          nickname: string;
                          picture: string;
                          zoneinfo?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  },
              >;
              updateProfile: (
                  parameters: {
                      accountId: string;
                      extended_profile?: {
                          department?: string;
                          job_title?: string;
                          location?: string;
                          organization?: string;
                          [key: string]: unknown;
                      };
                      locale?: string;
                      name?: string;
                      nickname?: string;
                      zoneinfo?: string;
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      account: {
                          account_id: string;
                          account_status: "active"
                          | "inactive"
                          | "closed"
                          | string & {};
                          account_type: string & {} | "atlassian" | "app" | "customer";
                          characteristics?: { not_mentionable?: boolean; [key: string]: unknown };
                          email: string;
                          extended_profile?: {
                              department?: string;
                              job_title?: string;
                              location?: string;
                              organization?: string;
                              [key: string]: unknown;
                          };
                          locale?: string;
                          name: string;
                          nickname: string;
                          picture: string;
                          zoneinfo?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  },
              >;
          };
      }