openapi: 3.0.1
info:
title: FlashArray REST Active Directory Policies (All) API
version: '2.52'
description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos
or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by
mapping identities across the NFS and SMB protocols by using LDAP queries.
'
servers:
- url: /
tags:
- name: Policies (All)
description: Displays general information for all available types of policies and their members.
paths:
/api/2.26/policies-all:
get:
tags:
- Policies (All)
summary: Pure Storage GET Policies-all
description: List all policies of all types.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Allow_errors'
- $ref: '#/components/parameters/Context_names_get'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyBaseGetResponse'
'207':
description: 'Partial success. Some resources were returned, but there
were also errors possibly preventing some resources from
being returned.
'
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyBaseGetResponse'
/api/2.26/policies-all/members:
get:
tags:
- Policies (All)
summary: Pure Storage GET Policies-all/members
description: 'List policies (of all types) mapped to other entities (file systems,
snapshots, file system replica links, and object store users).
Note: if more than 150,000 items would be returned in the response, an error will be thrown
and query parameters must be used to limit the items queried.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Allow_errors'
- $ref: '#/components/parameters/Context_names_get'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Local_file_system_ids'
- $ref: '#/components/parameters/Local_file_system_names'
- $ref: '#/components/parameters/Member_ids'
- $ref: '#/components/parameters/Member_names'
- $ref: '#/components/parameters/Member_types'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Policy_ids'
- $ref: '#/components/parameters/Policy_names'
- $ref: '#/components/parameters/Remote_file_system_ids'
- $ref: '#/components/parameters/Remote_file_system_names'
- $ref: '#/components/parameters/Remote_ids'
- $ref: '#/components/parameters/Remote_names'
- $ref: '#/components/parameters/Sort'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse'
'207':
description: 'Partial success. Some resources were returned, but there
were also errors possibly preventing some resources from
being returned.
'
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse'
components:
schemas:
_memberLink:
type: object
properties:
local_file_system:
description: Reference to a local file system.
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
remote:
description: Reference to a remote array or realm.
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
remote_file_system:
description: Reference to a remote file system.
title: FixedReferenceNoResourceType
allOf:
- $ref: '#/components/schemas/_fixedReferenceNoResourceType'
_fixedReferenceNoResourceType:
type: object
properties:
id:
description: 'A non-modifiable, globally unique ID chosen by the system.
'
type: string
readOnly: true
name:
type: string
readOnly: true
x-readOnly: true
PolicyMember:
type: object
properties:
member:
description: Reference to the resource the policy is applied to.
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
policy:
description: Reference to the policy.
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
_errorContextResponseErrors:
type: object
properties:
context:
description: 'Contains information relating to the cause of this error,
or the name of the object that was being processed when the error was encountered.
This may be `null` for more general errors.
'
type: string
location_context:
description: 'Contains information relating to the context in which the request was executing
when the error occurred.
For example, this may be the name of an array in the same fleet.
This may be `null` for more general errors, or if no explicit `context` parameter
was provided with the request.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
message:
description: A description of the error which occurred.
type: string
example: Resource does not exist.
_errorContextResponse:
type: object
properties:
errors:
description: The list of errors encountered when attempting to perform an operation.
type: array
readOnly: true
items:
$ref: '#/components/schemas/_errorContextResponseErrors'
PolicyBaseContext:
allOf:
- $ref: '#/components/schemas/PolicyBase'
- $ref: '#/components/schemas/_context'
_locationReference:
allOf:
- $ref: '#/components/schemas/_reference'
- type: object
properties:
display_name:
description: 'Full name of the source with remote array information.
Response will be same as source name for local file systems and policies.
'
type: string
readOnly: true
example: irp624-c02:fs1
is_local:
description: 'Is the location reference to the local array or somewhere remote?
'
type: boolean
readOnly: true
location:
description: 'A reference to the location where the object is defined.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference'
PolicyBase:
allOf:
- $ref: '#/components/schemas/PolicyBaseRenameable'
PolicyMemberWithRemote:
allOf:
- $ref: '#/components/schemas/_context'
- $ref: '#/components/schemas/PolicyFileSystemSnapshot'
- type: object
properties:
link:
description: 'Only populated if the `member` is a file system replica link. Contains additional
information about the link.
'
title: MemberLink
allOf:
- $ref: '#/components/schemas/_memberLink'
_reference:
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified.
'
type: string
name:
description: 'The resource name,
such as volume name, pod name, snapshot name, and so on.
'
type: string
resource_type:
description: 'Type of the object (full name of the endpoint).
Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`,
`ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`,
`volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and
`policies/snapshot`, etc.
'
type: string
readOnly: true
x-aliases:
- _referenceWithFixedType
_resource:
description: 'An ordinary (as opposed to built-in) resource that can be created, named,
renamed or deleted by the user. This might be a virtual resource (e.g., a
file system), or correspond to something in the environment, like a host or a
server.
'
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified and cannot refer to another resource.
'
type: string
readOnly: true
name:
description: 'A user-specified name.
The name must be locally unique and can be changed.
'
type: string
PolicyMemberWithRemoteResponse:
allOf:
- $ref: '#/components/schemas/_context'
- type: object
properties:
items:
description: A list of members for policies.
type: array
items:
$ref: '#/components/schemas/PolicyMemberWithRemote'
_fixedReferenceWithoutType:
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified.
'
type: string
readOnly: true
name:
description: 'The resource name, such as volume name, file system name,
snapshot name, and so on.
'
type: string
readOnly: true
x-readOnly: true
PolicyBaseResponse:
type: object
properties:
items:
description: A list of basic policy objects.
type: array
items:
$ref: '#/components/schemas/PolicyBaseContext'
PolicyBaseGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/PolicyBaseResponse'
- $ref: '#/components/schemas/_errorContextResponse'
PolicyMemberWithRemoteGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/PolicyMemberWithRemoteResponse'
- $ref: '#/components/schemas/_errorContextResponse'
_context:
type: object
properties:
context:
description: 'The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet
or to the fleet itself.
Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided `context`.
'
readOnly: true
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
PolicyBaseRenameable:
allOf:
- $ref: '#/components/schemas/_resource'
- $ref: '#/components/schemas/_realmsReference'
- type: object
properties:
enabled:
description: 'If `true`, the policy is enabled. If not specified, defaults to `true`.
'
type: boolean
is_local:
description: Whether the policy is defined on the local array.
type: boolean
readOnly: true
location:
description: Reference to the array where the policy is defined.
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
policy_type:
description: 'Type of the policy. Valid values include `alert`, `audit`, `bucket-access`,
`cross-origin-resource-sharing`, `network-access`, `nfs`, `object-access`,
`s3-export`, smb-client`, `smb-share`, `ssh-certificate-authority`, and
`telemetry-metrics`.
'
type: string
readOnly: true
_realmsReference:
type: object
properties:
realms:
description: 'Reference to the realms this resource belongs to.
The value is set to empty array when the resource
lives outside of a realm.
'
type: array
readOnly: true
items:
$ref: '#/components/schemas/_fixedReference'
_fixedReference:
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithoutType'
- type: object
properties:
resource_type:
description: 'Type of the object (full name of the endpoint).
Valid values are the unique part of the resource''s REST endpoint.
For example, a reference to a file system would have a
`resource_type` of `file-systems`.
'
type: string
readOnly: true
PolicyFileSystemSnapshot:
allOf:
- $ref: '#/components/schemas/PolicyMember'
- $ref: '#/components/schemas/_context'
- type: object
properties:
policy:
description: Reference to the policy. Location can be array or realm.
title: LocationReference
allOf:
- $ref: '#/components/schemas/_locationReference'
PageInfo:
type: object
properties:
continuation_token:
description: 'Continuation token that can be provided in the `continuation_token` query
param to get the next page of data.
If you use the `continuation_token` to page through data you
are guaranteed to get all items exactly once regardless of
how items are modified. If an item is added or deleted during
the pagination then it may or may not be returned.
The `continuation_token` is generated if the `limit` is less
than the remaining number of items, and the default sort is used
(no sort is specified).
'
type: string
total_item_count:
description: Total number of items after applying `filter` params.
type: integer
format: int32
parameters:
Filter:
name: filter
in: query
description: 'Narrows down the results to only the response objects
that satisfy the filter criteria.
'
schema:
type: string
Offset:
name: offset
in: query
description: 'The offset of the first resource to return from a collection.
'
schema:
type: integer
format: int32
minimum: 0
example: 10
Allow_errors:
name: allow_errors
in: query
description: 'If set to `true`, the API will allow the operation to continue even if there are errors.
Any errors will be returned in the `errors` field of the response.
If set to `false`, the operation will fail if there are any errors.
'
schema:
type: boolean
default: false
Policy_ids:
name: policy_ids
in: query
description: 'A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of `policy_ids`, then an error is returned.
This cannot be provided together with the `policy_names` query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Continuation_token:
name: continuation_token
in: query
description: 'A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set `continuation_token` to the system-generated token taken from the `x-next-token`
header field of the response.
A query has reached its last page when the response does not include a token.
Pagination requires the `limit` and `continuation_token`
query parameters.
'
schema:
type: string
Member_types:
name: member_types
in: query
description: 'A comma-separated list of member types. Valid values include `file-systems`,
`file-system-snapshots`, `file-system-replica-links`, `object-store-users`,
and `object-store-accounts`. Different endpoints may accept different subsets
of these values.
'
style: form
explode: false
schema:
type: array
items:
type: string
Policy_names:
name: policy_names
in: query
description: 'A comma-separated list of policy names.
'
style: form
explode: false
schema:
type: array
items:
type: string
XRequestId:
name: X-Request-ID
in: header
description: 'Supplied by client during request or generated by server.
'
schema:
type: string
Limit:
name: limit
in: query
description: 'Limits the size of the response to the specified number of objects on each page.
To return the total number of resources, set `limit=0`.
The total number of resources is returned as a `total_item_count` value.
If the page size requested is larger than the system maximum limit,
the server returns the maximum limit, disregarding the requested page size.
'
schema:
type: integer
format: int32
minimum: 0
example: 10
Remote_ids:
name: remote_ids
in: query
description: 'A comma-separated list of remote array IDs. If, after filtering, there is not at least one
resource that matches each of the elements, then an error is returned. This cannot be provided
together with the `remote_names` query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Names:
name: names
in: query
description: 'Performs the operation on the unique names specified.
Enter multiple names in comma-separated format.
For example, `name01,name02`.
If there is not at least one resource that matches
each of the elements of `names`, then an error is returned,
except when creating new resources.
'
style: form
explode: false
schema:
type: array
items:
type: string
Context_names_get:
name: context_names
in: query
description: 'Performs the operation on the unique contexts specified.
If specified, each context name must be the name of an array in the same fleet or
the name of the fleet itself.
If not specified, the context will default to the array that received this request.
Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided `context`.
Enter multiple names in comma-separated format.
For example, `name01,name02`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Member_ids:
name: member_ids
in: query
description: 'A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of `member_ids`, then an error is returned.
This cannot be provided together with the `member_names` query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Member_names:
name: member_names
in: query
description: 'A comma-separated list of member names.
'
style: form
explode: false
schema:
type: array
items:
type: string
Local_file_system_ids:
name: local_file_system_ids
in: query
description: 'A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
`local_file_system_names` query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Ids:
name: ids
in: query
description: 'A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of `ids`, then an error is returned.
This cannot be provided together with the `name` or `names` query parameters.
'
style: form
explode: false
schema:
type: array
items:
type: string
Remote_names:
name: remote_names
in: query
description: 'A comma-separated list of remote array names. If, after filtering, there is not at least one
resource that matches each of the elements, then an error is returned. This cannot be provided
together with the `remote_ids` query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Remote_file_system_names:
name: remote_file_system_names
in: query
description: 'A comma-separated list of remote file system names. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the `remote_file_system_ids`
query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Remote_file_system_ids:
name: remote_file_system_ids
in: query
description: 'A comma-separated list of remote file system IDs. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the `remote_file_system_names`
query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Sort:
name: sort
in: query
description: 'Sort the response by the specified fields (in descending order if ''-''
is appended to the field name).
NOTE: If you provide a sort you will not get a `continuation_token` in
the response.
'
style: form
explode: false
schema:
type: array
items:
pattern: ^[a-z]+(_[a-z]+)*-?
type: string
Local_file_system_names:
name: local_file_system_names
in: query
description: 'A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with `local_file_system_ids`
query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string