openapi: 3.0.1
info:
title: FlashArray REST Active Directory Object Store Access Keys 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: Object Store Access Keys
description: Manages object store access keys. A maximum of two sets of keys can be created for each object store user. A set of keys consists of an access key ID and Secret Access Key.
paths:
/api/2.52/object-store-access-keys:
get:
tags:
- Object Store Access Keys
summary: Pure Storage GET Object-store-access-keys
description: List object store access keys.
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/Names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
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/ObjectStoreAccessKeyGetResponse'
'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/ObjectStoreAccessKeyGetResponse'
post:
tags:
- Object Store Access Keys
summary: Pure Storage POST Object-store-access-keys
description: 'The generation of object store access keys. This process produces a new `access key ID` and
`secret key` for the specified user.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_objectStoreAccessKeyPostBase'
required: true
x-codegen-request-body-name: object-store-access-key
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/ObjectStoreAccessKeyResponse'
x-codegen-request-body-name: object-store-access-key
delete:
tags:
- Object Store Access Keys
summary: Pure Storage DELETE Object-store-access-keys
description: Delete an object store access key. Once an access key has been deleted, it cannot be recovered.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names_required'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content: {}
patch:
tags:
- Object Store Access Keys
summary: Pure Storage PATCH Object-store-access-keys
description: Enable or disable object store access keys.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names_required'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStoreAccessKey'
required: true
x-codegen-request-body-name: object-store-access-key
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/ObjectStoreAccessKeyResponse'
x-codegen-request-body-name: object-store-access-key
/api/2.26/object-store-access-keys:
get:
tags:
- Object Store Access Keys
summary: Pure Storage GET Object-store-access-keys
description: List object store access keys.
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/Names'
- $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/ObjectStoreAccessKeyGetResponse'
'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/ObjectStoreAccessKeyGetResponse'
post:
tags:
- Object Store Access Keys
summary: Pure Storage POST Object-store-access-keys
description: 'Create or import object store access keys. When importing an access key,
the access key id is provided by the `names` header parameter and the
the secret key must be also provided. When importing an access key for a
user in a realm, the value of `names` must be prefixed with the realm of the
user.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Access_key_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStoreAccessKeyPost'
required: true
x-codegen-request-body-name: object-store-access-key
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/ObjectStoreAccessKeyResponse'
x-codegen-request-body-name: object-store-access-key
delete:
tags:
- Object Store Access Keys
summary: Pure Storage DELETE Object-store-access-keys
description: Delete an object store access key. Once an access key has been deleted, it cannot be recovered.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names_required_2'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content: {}
patch:
tags:
- Object Store Access Keys
summary: Pure Storage PATCH Object-store-access-keys
description: Enable or disable object store access keys.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names_required_2'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStoreAccessKey_2'
required: true
x-codegen-request-body-name: object-store-access-key
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/ObjectStoreAccessKeyResponse'
x-codegen-request-body-name: object-store-access-key
components:
schemas:
ObjectStoreAccessKey_2:
allOf:
- $ref: '#/components/schemas/_builtInNoId'
- $ref: '#/components/schemas/_context_2'
- type: object
properties:
access_key_id:
description: 'The access key ID which can be used directly to
authorize S3 operations.
'
type: string
readOnly: true
created:
description: Creation timestamp of the object.
type: integer
format: int64
readOnly: true
enabled:
description: 'Is the access key enabled? If not specified, defaults to `false`.
'
type: boolean
secret_access_key:
description: 'The secret access key, only populated on creation if it is not
imported from another FlashBlade.
'
type: string
readOnly: true
user:
description: Reference of the associated user.
readOnly: true
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference_2'
ObjectStoreAccessKeyResponse:
type: object
properties:
items:
description: A list of object store access key objects.
type: array
items:
$ref: '#/components/schemas/ObjectStoreAccessKey'
_builtInNoId:
type: object
properties:
name:
description: Name of the object (e.g., a file system or snapshot).
type: string
readOnly: true
ObjectStoreAccessKeyGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/_errorContextResponse'
- $ref: '#/components/schemas/ObjectStoreAccessKeyResponse'
_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'
_referenceWithFixedType:
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
ObjectStoreAccessKey:
allOf:
- $ref: '#/components/schemas/_builtInResourceNoId'
- $ref: '#/components/schemas/_objectStoreAccessKeyBase'
_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
_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
_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: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
message:
description: A description of the error which occurred.
type: string
example: Resource does not exist.
x-aliases:
- _errorContextResponseErrors
_objectStoreAccessKeyPostBase:
type: object
properties:
user:
description: The user associated with the access key.
title: ReferenceWithFixedType
allOf:
- $ref: '#/components/schemas/_referenceWithFixedType'
_fixedReferenceWithType:
allOf:
- $ref: '#/components/schemas/_fixedReference'
- 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
x-aliases:
- _fixedReference
ObjectStoreAccessKeyPost:
type: object
properties:
secret_access_key:
description: 'The secret access key to import from another FlashBlade.
To import a set of credentials, this field must be specified
with the `names` query parameter where the `names` includes
prefix of the realm where the user lives. If both of these are not
specified, the system will generate a new set of credentials.
'
type: string
user:
type: object
allOf:
- $ref: '#/components/schemas/_reference'
- description: Reference of the associated user.
type: object
_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: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
_context_2:
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_2'
_fixedReference_2:
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
_objectStoreAccessKeyBase:
allOf:
- $ref: '#/components/schemas/_context'
- type: object
description: 'The object store access key credentials that allow programmatic access to an object store account.
Access keys are associated with a user and are used to authenticate and authorize operations on the object store.
'
properties:
created:
description: The object store access key creation time in milliseconds since the UNIX epoch.
type: integer
format: int64
readOnly: true
example: 1602115200000
enabled:
description: 'If set to `true`, the access key is enabled.
If set to `false`, the access key cannot be used for authentication.
The default value is `true`.
'
type: boolean
example: true
secret_access_key:
description: 'The secret access key. This value is returned only upon creation.
'
type: string
readOnly: true
user:
description: The user associated with the access key.
readOnly: true
title: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
_fixedReference:
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
x-aliases:
- _fixedReferenceWithoutType
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
_builtInResourceNoId:
description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support
settings). Some correspond to a piece of software, like an app, or hardware,
like a controller. Others are created by the system in response to some event
(e.g., alerts, audit records).
Typically, a user can''t create, delete or rename a built-in resource. A few
can be created or deleted, but not renamed because the names are meaningful
to Purity (e.g., VIFs, file systems, file system snapshots, volume snapshot).
'
type: object
properties:
name:
description: 'A locally unique, system-generated name. The name cannot be modified.
'
type: string
readOnly: true
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
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
Names_required_2:
name: names
in: query
description: 'A comma-separated list of resource names.
'
required: true
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
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
Context_names:
name: context_names
in: query
description: 'Performs the operation on the context specified.
If specified, the context names must be an array of size 1, and the single element
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`.
'
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
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
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
Access_key_names:
name: names
in: query
description: 'A comma-separated list of resource names to import.
To import a set of credentials, this field must be specified
with the `secret_access_key` body parameter. If both of these
are not specified, the system will generate a new set of credentials.
A matching realm prefix is required when importing credentials for
a user in a realm. For example, use
`realm1::PSFBSAZRBHOODCBADKNFKCBCPCNHLHMEJOIOHHBACEL` when importing
credentials for user `realmName::accountName/userName`.
'
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
Names_required:
name: names
in: query
description: 'Performs the operation on the unique name specified.
For example, `name01`.
Enter multiple names in comma-separated format.
'
required: true
style: form
explode: false
schema:
type: array
items:
type: string