Function getApiKeys

  • Lists API keys for the tenant. To list API keys owned by other users, requesting user must be assigned the TenantAdmin role.

    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
      • Optionallimit?: number
      • Optionalsort?:
            | "sub"
            | "status"
            | "createdByUser"
            | "+createdByUser"
            | "-createdByUser"
            | "+sub"
            | "-sub"
            | "+status"
            | "-status"
            | "description"
            | "+description"
            | "-description"
            | "created"
            | "+created"
            | "-created"
      • OptionalstartingAfter?: string
      • Optionalstatus?: "active" | "expired" | "revoked"
      • Optionalsub?: string
    • Optionaloptions: ApiCallOptions

    Returns Promise<GetApiKeysHttpResponse>

    GetApiKeysHttpError