Function getOAuthClients

  • Retrieve all OAuth clients.

    Parameters

    • query: {
          filter?: string;
          limit?: number;
          next?: string;
          prev?: string;
          sort?: string;
          totalResults?: boolean;
      }

      an object with query parameters

      • Optionalfilter?: string

        The filter query that should be used to filter the list of oauth clients. The filter syntax is defined in RFC 7644. Valid attributes for filtering are clientId, clientName, appType, and tenantId.

      • Optionallimit?: number

        The number of OAuth client entries to retrieve.

      • Optionalnext?: string

        The next page cursor

      • Optionalprev?: string

        The previous page cursor

      • Optionalsort?: string

        The attribute to sort by, beginning with + for ascending and - for descending. Valid attributes for sorting are clientId, clientName, appType, tenantId, createdAt, updatedAt.

      • OptionaltotalResults?: boolean

        Boolean query parameter that determines if the total count of results should be included in the response. If true, the response includes the total number of results in the totalResults field. If false or not included in the query, totalResults will be excluded from the response.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetOAuthClientsHttpResponse>

    getOAuthClients(
    {
    filter: "appType eq \"spa\" and clientId eq \"b3ee66d6f21d1611efa89a425f656f6f\"",
    totalResults: true
    }
    )

    GetOAuthClientsHttpError