openapi: 3.0.1
info:
title: FlashArray REST Active Directory Resource Accesses 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: Resource Accesses
paths:
/api/2.52/resource-accesses:
get:
tags:
- Resource Accesses
summary: Pure Storage List Resource Access Configurations
description: 'Displays a list of configured resource accesses.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids_without_names'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAccessesGetResponse'
delete:
tags:
- Resource Accesses
summary: Pure Storage Delete a Resource Access Configuration
description: 'Deletes a resource access object.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids_without_names'
responses:
'200':
description: OK
content: {}
/api/2.52/resource-accesses/batch:
post:
tags:
- Resource Accesses
summary: Pure Storage Create a Resource Access Configuration
description: 'Creates resource access objects.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResourceAccess'
required: true
x-codegen-request-body-name: items
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAccessesResponse'
x-codegen-request-body-name: items
/api/2.52/resource-accesses/status:
get:
tags:
- Resource Accesses
summary: Pure Storage List Status of Resource Accesses as Specified by Resource Access Configuration
description: 'Displays a list of effective resource accesses.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAccessesStatusGetResponse'
/api/2.26/resource-accesses:
get:
tags:
- Resource Accesses
summary: Pure Storage GET Resource-accesses
description: 'Returns a list of configured resource accesses.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit_scale'
- $ref: '#/components/parameters/Offset_2'
- $ref: '#/components/parameters/Sort_2'
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/ResourceAccessesGetResponse_2'
delete:
tags:
- Resource Accesses
summary: Pure Storage DELETE Resource-accesses
description: 'Delete resource access object.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content: {}
/api/2.26/resource-accesses/batch:
post:
tags:
- Resource Accesses
summary: Pure Storage POST Resource-accesses/batch
description: 'Create resource access objects.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResourceAccessPost'
required: true
x-codegen-request-body-name: items
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/ResourceAccessesResponse'
x-codegen-request-body-name: items
components:
schemas:
_referenceWithoutType:
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
ResourceAccessesStatusGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/ResourceAccessesStatusResponse'
ResourceAccessStatusCreatedBy:
description: 'Each Resource Access Status has a reference to the resource accesses that explain its existence.
'
type: object
properties:
id:
description: ID of a Resource Access.
type: string
implicit:
description: 'Set to `true` when this resource access status was not explicitly created, but instead, its
existence is implied by another resource access. Usually, this happens when a scope has access
to a group of resources (e.g., a host group). Then this scope has access to each member of
the group, individual hosts. Set to `false` when a resource access status reflects explicitly
created resource access.
Note that if there is both implicit and explicit access of an object to a scope, there will be
only one entry in the response for that object and scope pair. The `created_by` field will
contain both implicit and explicit resource access references.
'
type: boolean
PageInfoScale:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- type: object
properties:
more_items_remaining:
description: 'Returns a value of `true` if subsequent items can be retrieved.
'
type: boolean
example: false
_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
x-aliases:
- _referenceWithoutType
_referenceWritable:
allOf:
- $ref: '#/components/schemas/_referenceWithoutType'
- type: object
properties:
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`, `policies/snapshot`, etc.
'
type: string
x-aliases:
- _reference
_referenceWithType:
allOf:
- $ref: '#/components/schemas/_reference'
- type: object
properties:
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
x-aliases:
- _reference
ResourceAccessPost:
type: object
properties:
resource:
description: Resource to which the scope has access to.
title: ReferenceWritable
allOf:
- $ref: '#/components/schemas/_referenceWritable'
scope:
description: Scope which has access to the resource.
title: ReferenceWritable
allOf:
- $ref: '#/components/schemas/_referenceWritable'
ResourceAccess:
description: 'A resource access captures configuration of sharing a resource to a scope.
For example, resource access can specify that an array host is accessible from a realm.
'
type: object
properties:
id:
description: ID of a resource access object.
type: string
readOnly: true
resource:
description: Resource to which the scope has access.
title: ReferenceWithType
allOf:
- $ref: '#/components/schemas/_referenceWithType'
scope:
description: Scope which has access to the resource.
title: ReferenceWithType
allOf:
- $ref: '#/components/schemas/_referenceWithType'
ResourceAccessesResponse:
type: object
properties:
items:
description: A list of resource access objects.
type: array
items:
$ref: '#/components/schemas/ResourceAccess'
ResourceAccessesGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/ResourceAccessesResponse'
ResourceAccessesGetResponse_2:
allOf:
- $ref: '#/components/schemas/PageInfoScale'
- $ref: '#/components/schemas/ResourceAccessesResponse'
PageInfo_2:
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
ResourceAccessesStatusResponse:
type: object
properties:
items:
description: A list of resource access status objects.
type: array
items:
$ref: '#/components/schemas/ResourceAccessStatus'
ResourceAccessStatus:
description: 'A resource access status realizes the configuration of resource accesses. For instance, if there
is a resource access for a host group to a realm, resource access status would include
the explicit host group resource access as well as an implicit resource access for each host
in that host group.
'
type: object
properties:
created_by:
description: 'Reference the IDs of resource accesses that created this status.
'
type: array
readOnly: true
items:
$ref: '#/components/schemas/ResourceAccessStatusCreatedBy'
resource:
description: Resource to which the scope has access.
title: ReferenceWithType
allOf:
- $ref: '#/components/schemas/_referenceWithType'
scope:
description: Scope which has access to the resource.
title: ReferenceWithType
allOf:
- $ref: '#/components/schemas/_referenceWithType'
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
more_items_remaining:
description: 'Returns a value of `true` if subsequent items can be retrieved.
'
type: boolean
example: false
total_item_count:
description: 'The total number of records after applying all filter query parameters.
The `total_item_count` will be calculated if and only if the corresponding
query parameter `total_item_count` is set to `true`. If this query parameter
is not set or set to `false`, a value of `null` will be returned.
'
type: integer
format: int32
parameters:
Offset:
name: offset
in: query
description: 'The starting position based on the results of the query
in relation to the full set of response objects returned.
'
schema:
type: integer
format: int32
minimum: 0
example: 10
Filter:
name: filter
in: query
description: 'Narrows down the results to only the response objects
that satisfy the filter criteria.
'
schema:
type: string
Limit_scale:
name: limit
in: query
description: 'Limit the size of the response to the specified number of resources.
A `limit` of `0` can be used to get the number of resources without getting
all of the resources. It will be returned in the `total_item_count` field.
If a client asks for a page size larger than the available number, the request
is still valid. In that case the server just returns the available number of
items, disregarding the client''s page size request.
If the page size requested is larger than the system maximum limit,
the server returns the maximum limit, disregarding the requested page size.
If there are additional items `more_items_remaining` will be set to true.
Additional items can be fetched using the `offset` or `continuation_token` query
params.
'
schema:
type: integer
format: int32
minimum: 0
example: 10
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
Offset_2:
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
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
Authorization:
name: Authorization
in: header
description: 'Access token (in JWT format) required to use any API
endpoint (except `/oauth2`, `/login`, and `/logout`)
'
schema:
type: string
Sort_2:
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
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
Ids_without_names:
name: ids
in: query
description: 'Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
'
style: form
explode: false
schema:
type: array
items:
type: string
Total_item_count:
name: total_item_count
in: query
description: 'If set to `true`, the `total_item_count` matching the
specified query parameters is calculated and returned in
the response. If set to `false`, the `total_item_count`
is `null` in the response. This may speed up queries
where the `total_item_count` is large. If not specified,
defaults to `false`.
'
schema:
type: boolean
Sort:
name: sort
in: query
description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
style: form
explode: false
schema:
type: array
items:
pattern: ^[a-z]+(_[a-z]+)*-?
type: string