jira.js
    Preparing search index...

    Function getUsers

    • Get users from the specified directory. Filtering is supported with a single exact match (eq) against the userName and externalId attributes.

      Note: While this API enables pagination, sorting functionality is not supported.

      Parameters

      • client: Client
      • parameters: {
            attributes?: string;
            count?: number;
            directoryId: string;
            excludedAttributes?: string;
            filter?: string;
            startIndex?: number;
        }
        • Optionalattributes?: string

          Resource attributes to be included in response. Mutually exclusive from excludedAttributes. Example: userName,emails.value

        • Optionalcount?: number

          Desired maximum number of query results in the list response page.

        • directoryId: string

          The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.

        • OptionalexcludedAttributes?: string

          Resource attributes to be excluded from response. Mutually exclusive from attributes. Example: timezone,emails.type,department

        • Optionalfilter?: string

          Filter for userName or externalId. Example: userName eq "Atlassian"

        • OptionalstartIndex?: number

          A 1-based index of the first query result.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              itemsPerPage?: number;
              Resources?: {
                  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;
              }[];
              schemas?: string[];
              startIndex?: number;
              totalResults?: number;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility