VTvtex
Users

Get list of admin users

Changed on

Returns a list of registered admin users. The response is divided in pages. The query parameter numItems defines the number of items in each page, and consequently the amount of pages for the whole list.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
License ManagerServices access controlGet paged users

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/license-manager/site/pvt/logins/list/paged

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/license-manager/site/pvt/logins/list/paged
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Query parameters

numItemsinteger
Example:10

Number of items in the returned page.

pageNumberinteger
Example:1

Which page from the whole list will be returned.

sortstring
Example:name

Chooses the field that the list will be sorted by.

sortTypestring
Example:ASC

Defines the sorting order. ASC is used for ascendant order. DSC is used for descendant order.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

Success

Changes

  • 5103d0527e12Revision changes
    • info

      response property items/items/roles deprecated

    • info

      response property items/items/roles/items/ deprecated

  • 1f25afb9537dRevision changes
    • breaking

      for the query request parameter numItems, default value 10 was removed

    • breaking

      for the query request parameter pageNumber, default value 1 was removed

    • breaking

      for the query request parameter sort, default value name was removed

    • breaking

      for the query request parameter sortType, default value ASC was removed