jira.js
    Preparing search index...

    Function createUserProvisioningClient

    • Parameters

      Returns {
          groups: {
              createGroup: (
                  parameters: {
                      directoryId: string;
                      displayName?: string;
                      externalId?: string;
                      id?: string;
                      members?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      meta?: {
                          created?: unknown;
                          lastModified?: unknown;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      schemas?: string[];
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      displayName?: string;
                      externalId?: string;
                      id?: string;
                      members?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      meta?: {
                          created?: Date;
                          lastModified?: Date;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      schemas?: string[];
                      [key: string]: unknown;
                  },
              >;
              deleteGroup: (
                  parameters: { directoryId: string; id: string },
                  options?: RequestOptions,
              ) => Promise<void>;
              getGroup: (
                  parameters: { directoryId: string; id: string },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      displayName?: string;
                      externalId?: string;
                      id?: string;
                      members?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      meta?: {
                          created?: Date;
                          lastModified?: Date;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      schemas?: string[];
                      [key: string]: unknown;
                  },
              >;
              getGroups: (
                  parameters: {
                      count?: number;
                      directoryId: string;
                      filter?: string;
                      startIndex?: number;
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      itemsPerPage?: number;
                      Resources?: {
                          displayName?: string;
                          externalId?: string;
                          id?: string;
                          members?: {
                              $ref?: ...;
                              display?: ...;
                              type?: ...;
                              value?: ...;
                              [key: ...]: ...;
                          }[];
                          meta?: {
                              created?: (...)
                              | (...);
                              lastModified?: (...) | (...);
                              location?: (...) | (...);
                              resourceType?: (...) | (...) | (...) | (...) | (...);
                              [key: string]: unknown;
                          };
                          schemas?: string[];
                          [key: string]: unknown;
                      }[];
                      schemas?: string[];
                      startIndex?: number;
                      totalResults?: number;
                      [key: string]: unknown;
                  },
              >;
              patchGroup: (
                  parameters: {
                      directoryId: string;
                      id: string;
                      operations?: {
                          op?: string;
                          path?: string;
                          value?: unknown;
                          [key: string]: unknown;
                      }[];
                      schemas?: string[];
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      displayName?: string;
                      externalId?: string;
                      id?: string;
                      members?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      meta?: {
                          created?: Date;
                          lastModified?: Date;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      schemas?: string[];
                      [key: string]: unknown;
                  },
              >;
              replaceGroup: (
                  parameters: {
                      directoryId: string;
                      displayName?: string;
                      externalId?: string;
                      id: string;
                      members?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      meta?: {
                          created?: unknown;
                          lastModified?: unknown;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      schemas?: string[];
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      displayName?: string;
                      externalId?: string;
                      id?: string;
                      members?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      meta?: {
                          created?: Date;
                          lastModified?: Date;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      schemas?: string[];
                      [key: string]: unknown;
                  },
              >;
          };
          schemas: {
              getExtensionUserSchemas: (
                  parameters: { directoryId: string },
                  options?: RequestOptions,
              ) => Promise<Record<string, unknown>>;
              getGroupSchemas: (
                  parameters: { directoryId: string },
                  options?: RequestOptions,
              ) => Promise<Record<string, unknown>>;
              getSchemas: (
                  parameters: { directoryId: string },
                  options?: RequestOptions,
              ) => Promise<Record<string, unknown>>;
              getUserSchemas: (
                  parameters: { directoryId: string },
                  options?: RequestOptions,
              ) => Promise<Record<string, unknown>>;
          };
          scimLinks: {
              deleteProvisioningRecord: (
                  parameters: { aaId: string; orgId: string },
                  options?: RequestOptions,
              ) => Promise<void>;
              getScimLinks: (
                  parameters: { aaId: string; orgId: string },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      scimLinks?: {
                          atlassianAccountId?: string
                          | null;
                          directoryId: string;
                          orgId: string;
                          scimUserId: string;
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  },
              >;
              getScimLinksByEmail: (
                  parameters: { email: string; orgId: string },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      scimLinks?: {
                          atlassianAccountId?: string
                          | null;
                          directoryId: string;
                          orgId: string;
                          scimUserId: string;
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  },
              >;
              unlinkScimUser: (
                  parameters: {
                      orgId: string;
                      scimDirectoryId: string;
                      scimUserId: string;
                  },
                  options?: RequestOptions,
              ) => Promise<void>;
          };
          serviceProviderConfiguration: {
              getGroupResourceType: (
                  parameters: { directoryId: string },
                  options?: RequestOptions,
              ) => Promise<Record<string, unknown>>;
              getResourceTypes: (
                  parameters: { directoryId: string },
                  options?: RequestOptions,
              ) => Promise<Record<string, unknown>>;
              getServiceProviderConfig: (
                  parameters: { directoryId: string },
                  options?: RequestOptions,
              ) => Promise<Record<string, unknown>>;
              getUserResourceType: (
                  parameters: { directoryId: string },
                  options?: RequestOptions,
              ) => Promise<Record<string, unknown>>;
          };
          users: {
              createUser: (
                  parameters: {
                      active?: boolean;
                      attributes?: string;
                      department?: string;
                      directoryId: string;
                      displayName?: string;
                      emails?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      excludedAttributes?: string;
                      externalId?: string;
                      groups?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      id?: string;
                      meta?: {
                          created?: unknown;
                          lastModified?: unknown;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      name?: {
                          familyName?: string;
                          formatted?: string;
                          givenName?: string;
                          honorificPrefix?: string;
                          honorificSuffix?: string;
                          middleName?: string;
                          [key: string]: unknown;
                      };
                      nickName?: string;
                      organization?: string;
                      phoneNumbers?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      preferredLanguage?: string;
                      schemas?: string[];
                      timezone?: string;
                      title?: string;
                      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: {
                          department?: string;
                          organization?: string;
                          [key: string]: unknown;
                      };
                      "urn:scim:schemas:extension:atlassian-external:1.0"?: {
                          atlassianAccountId?: string;
                          [key: string]: unknown;
                      };
                      userName?: string;
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      active?: boolean;
                      department?: string;
                      displayName?: string;
                      emails?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      externalId?: string;
                      groups?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      id?: string;
                      meta?: {
                          created?: Date;
                          lastModified?: Date;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      name?: {
                          familyName?: string;
                          formatted?: string;
                          givenName?: string;
                          honorificPrefix?: string;
                          honorificSuffix?: string;
                          middleName?: string;
                          [key: string]: unknown;
                      };
                      nickName?: string;
                      organization?: string;
                      phoneNumbers?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      preferredLanguage?: string;
                      schemas?: string[];
                      timezone?: string;
                      title?: string;
                      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: {
                          department?: string;
                          organization?: string;
                          [key: string]: unknown;
                      };
                      "urn:scim:schemas:extension:atlassian-external:1.0"?: {
                          atlassianAccountId?: string;
                          [key: string]: unknown;
                      };
                      userName?: string;
                      [key: string]: unknown;
                  },
              >;
              deleteUser: (
                  parameters: { directoryId: string; userId: string },
                  options?: RequestOptions,
              ) => Promise<void>;
              getUser: (
                  parameters: {
                      attributes?: string;
                      directoryId: string;
                      excludedAttributes?: string;
                      userId: string;
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      active?: boolean;
                      department?: string;
                      displayName?: string;
                      emails?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      externalId?: string;
                      groups?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      id?: string;
                      meta?: {
                          created?: Date;
                          lastModified?: Date;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      name?: {
                          familyName?: string;
                          formatted?: string;
                          givenName?: string;
                          honorificPrefix?: string;
                          honorificSuffix?: string;
                          middleName?: string;
                          [key: string]: unknown;
                      };
                      nickName?: string;
                      organization?: string;
                      phoneNumbers?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      preferredLanguage?: string;
                      schemas?: string[];
                      timezone?: string;
                      title?: string;
                      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: {
                          department?: string;
                          organization?: string;
                          [key: string]: unknown;
                      };
                      "urn:scim:schemas:extension:atlassian-external:1.0"?: {
                          atlassianAccountId?: string;
                          [key: string]: unknown;
                      };
                      userName?: string;
                      [key: string]: unknown;
                  },
              >;
              getUsers: (
                  parameters: {
                      attributes?: string;
                      count?: number;
                      directoryId: string;
                      excludedAttributes?: string;
                      filter?: string;
                      startIndex?: number;
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      itemsPerPage?: number;
                      Resources?: {
                          active?: boolean;
                          department?: string;
                          displayName?: string;
                          emails?: { primary?: ...; type?: ...; value?: ...; [key: ...]: ... }[];
                          externalId?: string;
                          groups?: {
                              $ref?: ...;
                              display?: ...;
                              type?: ...;
                              value?: ...;
                              [key: ...]: ...;
                          }[];
                          id?: string;
                          meta?: {
                              created?: (...)
                              | (...);
                              lastModified?: (...) | (...);
                              location?: (...) | (...);
                              resourceType?: (...) | (...) | (...) | (...) | (...);
                              [key: string]: unknown;
                          };
                          name?: {
                              familyName?: (...)
                              | (...);
                              formatted?: (...) | (...);
                              givenName?: (...) | (...);
                              honorificPrefix?: (...) | (...);
                              honorificSuffix?: (...) | (...);
                              middleName?: (...) | (...);
                              [key: string]: unknown;
                          };
                          nickName?: string;
                          organization?: string;
                          phoneNumbers?: {
                              primary?: ...;
                              type?: ...;
                              value?: ...;
                              [key: ...]: ...;
                          }[];
                          preferredLanguage?: string;
                          schemas?: string[];
                          timezone?: string;
                          title?: string;
                          "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: {
                              department?: (...)
                              | (...);
                              organization?: (...) | (...);
                              [key: string]: unknown;
                          };
                          "urn:scim:schemas:extension:atlassian-external:1.0"?: {
                              atlassianAccountId?: (...)
                              | (...);
                              [key: string]: unknown;
                          };
                          userName?: string;
                          [key: string]: unknown;
                      }[];
                      schemas?: string[];
                      startIndex?: number;
                      totalResults?: number;
                      [key: string]: unknown;
                  },
              >;
              patchUser: (
                  parameters: {
                      attributes?: string;
                      directoryId: string;
                      excludedAttributes?: string;
                      operations?: {
                          op?: string;
                          path?: string;
                          value?: unknown;
                          [key: string]: unknown;
                      }[];
                      schemas?: string[];
                      userId: string;
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      active?: boolean;
                      department?: string;
                      displayName?: string;
                      emails?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      externalId?: string;
                      groups?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      id?: string;
                      meta?: {
                          created?: Date;
                          lastModified?: Date;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      name?: {
                          familyName?: string;
                          formatted?: string;
                          givenName?: string;
                          honorificPrefix?: string;
                          honorificSuffix?: string;
                          middleName?: string;
                          [key: string]: unknown;
                      };
                      nickName?: string;
                      organization?: string;
                      phoneNumbers?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      preferredLanguage?: string;
                      schemas?: string[];
                      timezone?: string;
                      title?: string;
                      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: {
                          department?: string;
                          organization?: string;
                          [key: string]: unknown;
                      };
                      "urn:scim:schemas:extension:atlassian-external:1.0"?: {
                          atlassianAccountId?: string;
                          [key: string]: unknown;
                      };
                      userName?: string;
                      [key: string]: unknown;
                  },
              >;
              replaceUser: (
                  parameters: {
                      active?: boolean;
                      attributes?: string;
                      department?: string;
                      directoryId: string;
                      displayName?: string;
                      emails?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      excludedAttributes?: string;
                      externalId?: string;
                      groups?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      id?: string;
                      meta?: {
                          created?: unknown;
                          lastModified?: unknown;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      name?: {
                          familyName?: string;
                          formatted?: string;
                          givenName?: string;
                          honorificPrefix?: string;
                          honorificSuffix?: string;
                          middleName?: string;
                          [key: string]: unknown;
                      };
                      nickName?: string;
                      organization?: string;
                      phoneNumbers?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      preferredLanguage?: string;
                      schemas?: string[];
                      timezone?: string;
                      title?: string;
                      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: {
                          department?: string;
                          organization?: string;
                          [key: string]: unknown;
                      };
                      "urn:scim:schemas:extension:atlassian-external:1.0"?: {
                          atlassianAccountId?: string;
                          [key: string]: unknown;
                      };
                      userId: string;
                      userName?: string;
                  },
                  options?: RequestOptions,
              ) => Promise<
                  {
                      active?: boolean;
                      department?: string;
                      displayName?: string;
                      emails?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      externalId?: string;
                      groups?: {
                          $ref?: string;
                          display?: string;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      id?: string;
                      meta?: {
                          created?: Date;
                          lastModified?: Date;
                          location?: string;
                          resourceType?: string & {}
                          | "USER"
                          | "GROUP"
                          | "DIRECTORY";
                          [key: string]: unknown;
                      };
                      name?: {
                          familyName?: string;
                          formatted?: string;
                          givenName?: string;
                          honorificPrefix?: string;
                          honorificSuffix?: string;
                          middleName?: string;
                          [key: string]: unknown;
                      };
                      nickName?: string;
                      organization?: string;
                      phoneNumbers?: {
                          primary?: boolean;
                          type?: string;
                          value?: string;
                          [key: string]: unknown;
                      }[];
                      preferredLanguage?: string;
                      schemas?: string[];
                      timezone?: string;
                      title?: string;
                      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: {
                          department?: string;
                          organization?: string;
                          [key: string]: unknown;
                      };
                      "urn:scim:schemas:extension:atlassian-external:1.0"?: {
                          atlassianAccountId?: string;
                          [key: string]: unknown;
                      };
                      userName?: string;
                      [key: string]: unknown;
                  },
              >;
          };
      }