openapi: 3.0.1
info:
title: FlashArray REST Active Directory Certificate Groups 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: Certificate Groups
description: 'Certificate groups, also known as certificate bundles, are collections of digital certificates.
Each certificate can belong to one or more groups in order to serve different purposes.
'
paths:
/api/2.52/certificate-groups:
get:
tags:
- Certificate Groups
summary: Pure Storage List Certificate-groups
description: 'Display all array certificate groups.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $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'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateGroupGetResponse'
post:
tags:
- Certificate Groups
summary: Pure Storage Create Certificate-groups
description: 'Creates one or more certificate groups on the array.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Names'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateGroupResponse'
delete:
tags:
- Certificate Groups
summary: Pure Storage Delete Certificate-groups
description: 'Deletes one or more certificate groups from the array.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
responses:
'200':
description: OK
content: {}
/api/2.52/certificate-groups/certificates:
get:
tags:
- Certificate Groups
summary: Pure Storage List Certificate-groups and Certificates
description: 'Lists membership associations between groups and certificates on the array.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Certificate_group_ids'
- $ref: '#/components/parameters/Certificate_group_names'
- $ref: '#/components/parameters/Certificate_ids'
- $ref: '#/components/parameters/Certificate_names'
- $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/CertificateGroupCertificateGetResponse'
post:
tags:
- Certificate Groups
summary: Pure Storage Create Certificate-groups/certificates
description: 'Creates one or more certificates to one or more certificate groups on the array.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Certificate_group_ids'
- $ref: '#/components/parameters/Certificate_group_names'
- $ref: '#/components/parameters/Certificate_ids'
- $ref: '#/components/parameters/Certificate_names'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateGroupCertificateResponse'
delete:
tags:
- Certificate Groups
summary: Pure Storage Delete Certificate-groups or Certificates
description: 'Deletes one or more certificate groups.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Certificate_group_ids'
- $ref: '#/components/parameters/Certificate_group_names'
- $ref: '#/components/parameters/Certificate_ids'
- $ref: '#/components/parameters/Certificate_names'
responses:
'200':
description: OK
content: {}
/api/2.52/certificate-groups/uses:
get:
tags:
- Certificate Groups
summary: Pure Storage List Certificate-groups/uses
description: 'Lists how certificate groups are being used and by what.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $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'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateGroupUseGetResponse'
/api/2.26/certificate-groups:
get:
tags:
- Certificate Groups
summary: Pure Storage GET Certificate-groups
description: Display all array certificate groups.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids_2'
- $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/CertificateGroupGetResponse'
post:
tags:
- Certificate Groups
summary: Pure Storage POST Certificate-groups
description: Create one or more certificate groups on the array.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Names'
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/CertificateGroupResponse_2'
delete:
tags:
- Certificate Groups
summary: Pure Storage DELETE Certificate-groups
description: Delete one or more certificate groups from the array.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids_2'
- $ref: '#/components/parameters/Names'
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/certificate-groups/certificates:
get:
tags:
- Certificate Groups
summary: Pure Storage GET Certificate-groups/certificates
description: List membership associations between groups and certificates on the array.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Certificate_group_ids'
- $ref: '#/components/parameters/Certificate_group_names'
- $ref: '#/components/parameters/Certificate_ids'
- $ref: '#/components/parameters/Certificate_names_2'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $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/CertificateGroupCertificateGetResp'
post:
tags:
- Certificate Groups
summary: Pure Storage POST Certificate-groups/certificates
description: Add one or more certificates to one or more certificate groups on the array.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Certificate_group_ids'
- $ref: '#/components/parameters/Certificate_group_names'
- $ref: '#/components/parameters/Certificate_ids'
- $ref: '#/components/parameters/Certificate_names_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/CertificateGroupCertificateResponse_2'
delete:
tags:
- Certificate Groups
summary: Pure Storage DELETE Certificate-groups/certificates
description: Delete one or more certificate groups.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Certificate_group_ids'
- $ref: '#/components/parameters/Certificate_group_names'
- $ref: '#/components/parameters/Certificate_ids'
- $ref: '#/components/parameters/Certificate_names_2'
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/certificate-groups/uses:
get:
tags:
- Certificate Groups
summary: Pure Storage GET Certificate-groups/uses
description: List how certificate groups are being used and by what.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids_2'
- $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/CertificateGroupUseGetResponse'
components:
schemas:
_builtIn_2:
type: object
properties:
id:
description: 'A non-modifiable, globally unique ID chosen by the system.
'
type: string
readOnly: true
name:
description: Name of the object (e.g., a file system or snapshot).
type: string
readOnly: true
Member:
type: object
properties:
group:
description: 'A reference to a group object that has the referenced member object
as a member.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference_2'
member:
description: 'A reference to an object that is a member of the referenced group.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference_2'
CertificateGroupCertificateGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/CertificateGroupCertificateResponse'
CertificateGroupCertificateGetResp:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- $ref: '#/components/schemas/CertificateGroupCertificateResponse_2'
_memberWithType:
type: object
properties:
group:
$ref: '#/components/schemas/_referenceWithType'
member:
$ref: '#/components/schemas/_referenceWithType'
_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
CertificateGroupUse:
allOf:
- $ref: '#/components/schemas/_builtIn'
- type: object
properties:
use:
description: 'A reference to an object using this certificate group.
'
title: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
CertificateGroupCertificateResponse_2:
type: object
properties:
items:
description: 'A list of certificate and certificate group relationships.
'
type: array
items:
$ref: '#/components/schemas/Member'
CertificateGroup:
allOf:
- $ref: '#/components/schemas/_builtIn'
_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
CertificateGroupCertificateResponse:
type: object
properties:
items:
description: 'A list of certificate and certificate group relationships.
'
type: array
items:
$ref: '#/components/schemas/_memberWithType'
_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
CertificateGroupUseGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- type: object
properties:
items:
description: A list of certificate group use objects.
type: array
items:
$ref: '#/components/schemas/CertificateGroupUse'
_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
CertificateGroupResponse:
type: object
properties:
items:
description: 'A list of certificate group objects.
'
type: array
items:
$ref: '#/components/schemas/CertificateGroup'
_builtIn:
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).
'
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 locally unique, system-generated name. The name cannot be modified.
'
type: string
readOnly: true
CertificateGroupGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/CertificateGroupResponse'
_reference_2:
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
CertificateGroup_2:
allOf:
- $ref: '#/components/schemas/_builtIn_2'
- $ref: '#/components/schemas/_realmsReference'
_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
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
_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_2'
_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
CertificateGroupResponse_2:
type: object
properties:
items:
description: A list of certificate group objects.
type: array
items:
$ref: '#/components/schemas/CertificateGroup_2'
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:
Certificate_group_ids:
name: certificate_group_ids
in: query
description: 'A comma-separated list of certificate group ids.
If there is not at least one resource that matches each of the
elements of `certificate_group_ids`, then an error is returned.
This cannot be provided in conjunction with the `certificate_group_names` parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
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
Certificate_names:
name: certificate_names
in: query
description: 'The names of one or more certificates.
Enter multiple names in comma-separated format.
For example, `cert01,cert02`.
'
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
Certificate_group_names:
name: certificate_group_names
in: query
description: 'A comma-separated list of certificate group names.
If no resource matches each of the elements of `certificate_group_names`,
then an error is returned.
This cannot be provided in conjunction with the `certificate_group_ids` parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Certificate_ids:
name: certificate_ids
in: query
description: 'A comma-separated list of certificate ids.
If there is not at least one resource that matches each of the
elements of `certificate_ids`, then an error is returned.
This cannot be provided in conjunction with the `certificate_names`
parameter.
'
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
Certificate_names_2:
name: certificate_names
in: query
description: 'A comma-separated list of certificate names.
If there is not at least one resource that matches each of the
elements of `certificate_names`, then an error is returned.
This cannot be provided in conjunction with the `certificate_ids`
parameter.
'
style: form
explode: false
schema:
type: array
items:
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
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 unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n"
style: form
explode: false
schema:
type: array
items:
type: string
Ids_2:
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
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