Skip to main content

List all permissions

Contributors

GET /permissions

Lists all permissions.

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 metadata 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 permissions
Name Type Required Description

continue

string

False

count

int

False

items

array[Any of: permission_1.0_get_response_body, array[]]

True

metadata

type_bxp_metadata_list

False

Metadata associated with a list of resources.
Example response 
{
  "items": [
    {
      "description": "Added permission which allow user to read in aiq",
      "id": "666a3f38-d4fa-5b62-a391-a69029758d32",
      "metadata": {
        "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269",
        "creationTimestamp": "2022-10-06T20:58:16.305662Z",
        "labels": [],
        "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
        "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269"
      },
      "rule": "aiq:system-read",
      "serviceApplication": "aiq",
      "type": "application/vnd.netapp.bxp.permission",
      "version": "1.0"
    },
    {
      "description": "Added permission which allow user to read in aiq",
      "id": "666a3f38-d4fa-5b62-a391-a69029758d32",
      "metadata": {
        "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269",
        "creationTimestamp": "2022-10-06T20:58:16.305662Z",
        "labels": [],
        "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
        "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269"
      },
      "rule": "bxp:organization-read",
      "serviceApplication": "bxp",
      "type": "application/vnd.netapp.bxp.permission",
      "version": "1.0"
    }
  ]
}

Definitions

See Definitions

accept-post

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

accept-put

Provides details about which 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

Provides details about which 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.

See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details.

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.

See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details.

title

string

False

Label of a link so that it can be used as a human-readable identifier (for example, 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.

See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details.

type_bxp_label

Name/value pair

Name Type Required Description

name

string

True

value

string

True

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.

tags Hash mapping strings to string

permission_1.0_get_response_body

Name Type Required Description

description

string

False

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

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"

links

array[type_bxp_link]

False

metadata

type_bxp_metadata

False

Metadata associated with the resource

rule

string

True

JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

  • This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.

service_application

string

True

JSON string containing the service application associated with the permission.

tags

array[tags]

False

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

type

string

True

Media type of the resource. Defined values are:

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

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.