Skip to main content

List all users

GET /users

Lists all users in the collection.

Parameters

Name Type In Required Description

filter

string

query

False

Specifies which fields should be matched in order to return a resource when listing a collection.

Supported operators:

  • eq - Equality

  • lt/gt - Less than/greater than

  • lte/gte - Less than or equal to/greater than or equal to

URL example: "filter=field%20eq%20%27value%27"

OpenAPI examples: "field eq 'value'"

skip

string

query

False

Specifies the number of resources to skip when listing a collection.

URL examples: "skip=1"

OpenAPI examples: "1"

include

string

query

False

Specifies which fields should be returned when listing a collection.

URL examples: "include=id", "include=id,name"

OpenAPI examples: "id"

limit

string

query

False

Specifies the maximum number of resources to return when listing a collection.

URL examples: "limit=2"

OpenAPI examples: "2"

orderBy

string

query

False

Indicates the sort order of resources when listing a collection.

URL examples: "orderBy=name", "orderBy=name%20desc"

OpenAPI examples: "name desc"

count

string

query

False

Indicates if the total number of resources should be returned in the response object.

URL examples: "count=true"

OpenAPI examples: "true"

continue

string

query

False

Indicates the token to resume from when listing a collection.

URL examples: "continue=[Continue Token from Collection Metadata]"

OpenAPI examples: "[Continue Token from Collection Metadata]"

Response

Status: 200, List of all users.
Name Type Required Description

continue

string

False

count

integer

False

items

array[user_1.0_get_response_body]

True

metadata

type_bxp_metadata_list

False

Metadata associated with a list of resources.

Example response
{
  "continue": "string",
  "count": 1,
  "items": [
    {
      "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a",
      "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM",
      "description": "This user is part of NetApp Sales Territory",
      "editable": "string",
      "id": "666a3f38-d4fa-5b62-a391-a69029758d32",
      "isSystem": "true",
      "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32",
      "links": [
        {
          "hints": {
            "allow": [
              "string"
            ],
            "permissions": [
              "string"
            ],
            "status": "string"
          },
          "href": "string",
          "rel": "string",
          "title": "string",
          "type": "string"
        }
      ],
      "metadata": {
        "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
        "creationTimestamp": "2022-10-06T20:58:16.305662Z",
        "labels": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
        "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
      },
      "name": "string",
      "ownerOrganizationId": "string",
      "partner": "string",
      "serviceAccount": {
        "audience": "https://netapp-cloud-account.auth0.com/",
        "authenticationMethod": "PRIVATE_KEY_JWT",
        "expirationNotificationPeriod": "P30D",
        "publicKeys": [
          {
            "audience": "https://netapp-cloud-account.auth0.com/",
            "expirationTimestamp": "2026-06-24T16:25:08Z",
            "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8",
            "id": "4336388b-2992-43af-81de-ba9284b7dc36",
            "keyType": "X509_CERTIFICATE",
            "metadata": {
              "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269",
              "creationTimestamp": "2025-06-24T16:25:08Z",
              "modificationTimestamp": "2025-06-24T16:25:08Z",
              "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
            },
            "state": "ENABLED",
            "type": "application/vnd.netapp.bxp.publickey+json",
            "version": "1.0"
          }
        ]
      },
      "state": "ACTIVE",
      "tags": [
        "object"
      ],
      "type": "application/vnd.netapp.bxp.user",
      "userType": "serviceAccount",
      "version": "1.0"
    }
  ],
  "metadata": {
    "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "labels": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
  }
}

Definitions

See Definitions

accept-post

Provides details about which media types are accepted when creating a resource.

accept-put

Indicates details about what media types are accepted when updating a resource.

hints

Name Type Required Description

accept-post

accept-post

False

Provides details about which media types are accepted when creating a resource.

accept-put

accept-put

False

Indicates details about what media types are accepted when updating a resource.

allow

array[string]

False

An array of methods that can be used to interact with the link target.

Defined values for collections:

"POST" - Indicates if new resources can be created in the collection. Defined values for resources:

"PUT" - Indicates if the resource can be modified "DELETE" - Indicates if the resource can be deleted

permissions

array[string]

False

List of the permissions required to use the link.

status

string

False

Indicates if the target of the link is deprecated.

Defined values are:

"deprecated"

targetSchema

Link to a JSON schema that can be used to validate the target of the link (response body).

The preferred format is a $ref link to an external schema.

This field is optional and should only be included when there is a known schema for the target of the href.

Link relationship

Name Type Required Description

hints

hints

False

href

string

True

String describing a relative URI.

rel

string

True

The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288.

targetSchema

targetSchema

False

Link to a JSON schema that can be used to validate the target of the link (response body).

The preferred format is a $ref link to an external schema.

This field is optional and should only be included when there is a known schema for the target of the href.

title

string

False

Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry).

Minimum length: 0 Maximum length: 1023

type

string

False

The media type of the target of the href.

This field is optional and should be included when there is a known media type for the target of the href.

type_bxp_label

Name/value pair.

Name Type Required Description

name

string

True

Name of the label.

value

string

True

Value of the label.

type_bxp_metadata

Metadata associated with the resource.

Name Type Required Description

createdBy

string

False

UUID of the user who created the resource.

creationTimestamp

string

False

Resource creation date.

labels

array[type_bxp_label]

False

Array of name/value pairs representing additional information for the resource.

modificationTimestamp

string

False

Resource modification date.

modifiedBy

string

False

UUID of the user who modified the resource.

user_1.0_public_key_get_response_body

Name Type Required Description

audience

string

False

The value that must be included in the 'audience' claim of the private key JWT token.

credentialId

string

False

The Auth0 credential ID associated with the public key.

expirationTimestamp

string

False

The date and time when the public key expires.

fingerprint

string

False

The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key.

id

string

True

Globally unique identifier of the resource conforming to the UUIDv4 schema.

keyType

string

False

Type of the public key. Defined values are:

  • "X509_CERTIFICATE" - The public key is an X.509 certificate.

  • "RSA_KEY" - The public key is an RSA key.

metadata

type_bxp_metadata

False

Metadata associated with the resource.

state

string

False

The state of the public key. Defined values are:

  • "ENABLED" - The public key is enabled.

  • "DISABLED" - The public key is disabled.

type

string

True

Media type of the resource. Defined values are:

  • "application/vnd.netapp.bxp.publickey"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

serviceAccount

Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT.

Name Type Required Description

audience

string

False

The value that must be included in the 'audience' claim of the private key JWT token.

authenticationMethod

string

False

Authentication method used by the service account. Defined values are:

  • "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token.

  • "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token.

expirationNotificationPeriod

string

False

The time period when expiration notifications are generated. Defined values are:

  • "P7D" - Notifications are sent daily 7 days before expiration.

  • "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration.

publicKeys

array[user_1.0_public_key_get_response_body]

False

List of public keys associated with the service account.

tags Hash mapping strings to string

user_1.0_get_response_body

Name Type Required Description

aadId

string

False

User AAD ID.

auth0Id

string

False

User auth0 ID.

description

string

False

JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.

editable

string

False

partner organization is editable or not.

id

string

True

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

isSystem

string

False

Specifies if an object is system generated. Defined values are:

  • "true"

legacyId

string

False

Unique identifier as understood by the previous version of this service.

links

array[type_bxp_link]

False

metadata

type_bxp_metadata

False

Metadata associated with the resource.

name

string

False

User name.

ownerOrganizationId

string

True

JSON string containing the ID of the organization.

partner

string

False

partner organization name.

serviceAccount

serviceAccount

False

Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT.

state

string

False

Current state of the user. Defined values are:

** "ACTIVE"

** "INACTIVE"

tags

array[tags]

False

JSON array of tags (name/value pairs) representing metadata for the user.

type

string

True

Media type of the resource. Defined values are:

  • "application/vnd.netapp.bxp.user"

userType

string

False

Type of user.

version

string

True

Version of the resource. Defined values are:

  • "1.0"

type_bxp_metadata_list

Metadata associated with a list of resources.

Name Type Required Description

count

number

False

createdBy

string

False

UUID of the user who created the resource.

creationTimestamp

string

False

Resource creation date.

labels

array[type_bxp_label]

False

Array of name/value pairs representing additional information for the resource.

modificationTimestamp

string

False

Resource modification date.

modifiedBy

string

False

UUID of the user who modified the resource.