Interface LicensesAPI

interface LicensesAPI {
    addLicenseAssignments: (
        body: AssignmentsActionsAddRequest,
        options?: ApiCallOptions,
    ) => Promise<AddLicenseAssignmentsHttpResponse>;
    clearCache: () => void;
    deleteLicenseAssignments: (
        body: AssignmentsActionsDeleteRequest,
        options?: ApiCallOptions,
    ) => Promise<DeleteLicenseAssignmentsHttpResponse>;
    getLicenseAssignments: (
        query: {
            filter?: string;
            limit?: number;
            orphans?: boolean;
            page?: string;
            sort?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetLicenseAssignmentsHttpResponse>;
    getLicenseConsumption: (
        query: {
            filter?: string;
            limit?: number;
            page?: string;
            sort?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetLicenseConsumptionHttpResponse>;
    getLicenseOverview: (
        options?: ApiCallOptions,
    ) => Promise<GetLicenseOverviewHttpResponse>;
    getLicenseSettings: (
        options?: ApiCallOptions,
    ) => Promise<GetLicenseSettingsHttpResponse>;
    getLicenseStatus: (
        options?: ApiCallOptions,
    ) => Promise<GetLicenseStatusHttpResponse>;
    updateLicenseAssignments: (
        body: AssignmentsActionsUpdateRequest,
        options?: ApiCallOptions,
    ) => Promise<UpdateLicenseAssignmentsHttpResponse>;
    updateLicenseSettings: (
        body: SettingsBody,
        options?: ApiCallOptions,
    ) => Promise<UpdateLicenseSettingsHttpResponse>;
}
Index

Properties

addLicenseAssignments clearCache deleteLicenseAssignments getLicenseAssignments getLicenseConsumption getLicenseOverview getLicenseSettings getLicenseStatus updateLicenseAssignments updateLicenseSettings

Properties

addLicenseAssignments: (
    body: AssignmentsActionsAddRequest,
    options?: ApiCallOptions,
) => Promise<AddLicenseAssignmentsHttpResponse>

Assigns license access to the given users

Type Declaration

Param: body

an object with the body content

AddLicenseAssignmentsHttpError

clearCache: () => void

Clears the cache for licenses api requests.

Type Declaration

    • (): void

    • Clears the cache for licenses api requests.

      Returns void

deleteLicenseAssignments: (
    body: AssignmentsActionsDeleteRequest,
    options?: ApiCallOptions,
) => Promise<DeleteLicenseAssignmentsHttpResponse>

Removes license access for the given users

Type Declaration

Param: body

an object with the body content

DeleteLicenseAssignmentsHttpError

getLicenseAssignments: (
    query: {
        filter?: string;
        limit?: number;
        orphans?: boolean;
        page?: string;
        sort?: string;
    },
    options?: ApiCallOptions,
) => Promise<GetLicenseAssignmentsHttpResponse>

Retrieves assignments for the current tenant

Type Declaration

    • (
          query: {
              filter?: string;
              limit?: number;
              orphans?: boolean;
              page?: string;
              sort?: string;
          },
          options?: ApiCallOptions,
      ): Promise<GetLicenseAssignmentsHttpResponse>

    • Retrieves assignments for the current tenant

      Parameters

      • query: {
            filter?: string;
            limit?: number;
            orphans?: boolean;
            page?: string;
            sort?: string;
        }

        an object with query parameters

        • Optionalfilter?: string

          The filter for finding entries.

        • Optionallimit?: number

          The preferred number of entries to return.

        • Optionalorphans?: boolean

          Only return assignments which are 'orphans' in the current tenant.

        • Optionalpage?: string

          The requested page.

        • Optionalsort?: string

          The field to sort on; can be prefixed with +/- for ascending/descending sort order.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetLicenseAssignmentsHttpResponse>

      GetLicenseAssignmentsHttpError

an object with query parameters

GetLicenseAssignmentsHttpError

getLicenseConsumption: (
    query: { filter?: string; limit?: number; page?: string; sort?: string },
    options?: ApiCallOptions,
) => Promise<GetLicenseConsumptionHttpResponse>

Retrieves license consumption for the current tenant

Type Declaration

    • (
          query: { filter?: string; limit?: number; page?: string; sort?: string },
          options?: ApiCallOptions,
      ): Promise<GetLicenseConsumptionHttpResponse>

    • Retrieves license consumption for the current tenant

      Parameters

      • query: { filter?: string; limit?: number; page?: string; sort?: string }

        an object with query parameters

        • Optionalfilter?: string

          The SCIM filter for the query. Filterable property is "endTime".

        • Optionallimit?: number

          The preferred number of entries to return.

        • Optionalpage?: string

          The requested page.

        • Optionalsort?: string

          The field to sort on; can be prefixed with +/- for ascending/descending sort order.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetLicenseConsumptionHttpResponse>

      GetLicenseConsumptionHttpError

an object with query parameters

GetLicenseConsumptionHttpError

getLicenseOverview: (
    options?: ApiCallOptions,
) => Promise<GetLicenseOverviewHttpResponse>

Gets the general information of the license applied to the current tenant

Type Declaration

GetLicenseOverviewHttpError

getLicenseSettings: (
    options?: ApiCallOptions,
) => Promise<GetLicenseSettingsHttpResponse>

Get auto assign settings for tenant.

Type Declaration

GetLicenseSettingsHttpError

getLicenseStatus: (
    options?: ApiCallOptions,
) => Promise<GetLicenseStatusHttpResponse>

Gets the license status information of the current tenant

Type Declaration

GetLicenseStatusHttpError

updateLicenseAssignments: (
    body: AssignmentsActionsUpdateRequest,
    options?: ApiCallOptions,
) => Promise<UpdateLicenseAssignmentsHttpResponse>

Updates license access for the given users

Type Declaration

Param: body

an object with the body content

UpdateLicenseAssignmentsHttpError

updateLicenseSettings: (
    body: SettingsBody,
    options?: ApiCallOptions,
) => Promise<UpdateLicenseSettingsHttpResponse>

Set auto assign settings for tenant

Type Declaration

Param: body

an object with the body content

UpdateLicenseSettingsHttpError

Settings

Member Visibility

On This Page

Properties