Function getApiKeys

Parameters

• query: {
      createdByUser?: string;
      endingBefore?: string;
      limit?: number;
      sort?:
          | "sub"
          | "status"
          | "createdByUser"
          | "+createdByUser"
          | "-createdByUser"
          | "+sub"
          | "-sub"
          | "+status"
          | "-status"
          | "description"
          | "+description"
          | "-description"
          | "created"
          | "+created"
          | "-created";
      startingAfter?: string;
      status?: "active"
      | "expired"
      | "revoked";
      sub?: string;
  }

  an object with query parameters

  • OptionalcreatedByUser?: string

    The user ID that created the API key.

  • OptionalendingBefore?: string

    Get resources with IDs that are lower than the target resource ID. Cannot be used in conjunction with startingAfter.

  • Optionallimit?: number

    Maximum number of API keys to retrieve.

  • Optionalsort?:
        | "sub"
        | "status"
        | "createdByUser"
        | "+createdByUser"
        | "-createdByUser"
        | "+sub"
        | "-sub"
        | "+status"
        | "-status"
        | "description"
        | "+description"
        | "-description"
        | "created"
        | "+created"
        | "-created"

    The field to sort by, with +/- prefix indicating sort order

  • OptionalstartingAfter?: string

    Get resources with IDs that are higher than the target resource ID. Cannot be used in conjunction with endingBefore.

  • Optionalstatus?: "active" | "expired" | "revoked"

    The status of the API key.

  • Optionalsub?: string

    The ID of the subject. For SCIM the format is SCIM\\{{IDP-ID}}, where {{IDP-ID}} is the ID of the IDP in Qlik. For users, use their user ID, e.g. 64ef645a3b7009d55dee5a2b.

• Optionaloptions: ApiCallOptions