openapi: 3.0.1 info: title: FlashArray REST Active Directory Policies - S3 Export 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 - S3 Export description: 'Manages S3 export policies for Object Store Account Exports. These policies contain rules which govern which buckets from the account are actually exported to the servers. ' paths: /api/2.26/s3-export-policies: get: tags: - Policies - S3 Export summary: Pure Storage GET S3-export-policies description: 'List S3 export policies. ' 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/S3ExportPolicyGetResponse' '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/S3ExportPolicyGetResponse' post: tags: - Policies - S3 Export summary: Pure Storage POST S3-export-policies description: 'Create a new S3 export policy. A non-empty list must be supplied in `servers`. The export is enabled after creation by default, this can be changed by setting `export_enabled` to `false`. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/S3ExportPolicyPost' required: true x-codegen-request-body-name: policy 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/S3ExportPolicyResponse' x-codegen-request-body-name: policy delete: tags: - Policies - S3 Export summary: Pure Storage DELETE S3-export-policies description: 'Delete an S3 export policy. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $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: {} patch: tags: - Policies - S3 Export summary: Pure Storage PATCH S3-export-policies description: 'Modify an existing S3 export policy. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/S3ExportPolicyPatch' required: true x-codegen-request-body-name: policy 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/S3ExportPolicyResponse' x-codegen-request-body-name: policy /api/2.26/s3-export-policies/rules: get: tags: - Policies - S3 Export summary: Pure Storage GET S3-export-policies/rules description: 'List rules for the specified S3 export policy. Currently, either `policy_names` or `policy_ids` query parameters must be used and contain exactly one element. ' 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/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $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/S3ExportPolicyRuleGetResponse' '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/S3ExportPolicyRuleGetResponse' post: tags: - Policies - S3 Export summary: Pure Storage POST S3-export-policies/rules description: 'Create a new rule for the specified S3 export policy. Either `policy_names` or `policy_ids` query parameters can be used. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/S3ExportPolicyRulePost' required: true x-codegen-request-body-name: rule 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/S3ExportPolicyRuleResponse' x-codegen-request-body-name: rule delete: tags: - Policies - S3 Export summary: Pure Storage DELETE S3-export-policies/rules description: 'Delete rules for the specified S3 export policy. Either `policy_names` or `policy_ids` query parameters can be used. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Policies - S3 Export summary: Pure Storage PATCH S3-export-policies/rules description: 'Modify rules of S3 export policies. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/S3ExportPolicyRulePost' required: true x-codegen-request-body-name: rule 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/S3ExportPolicyRuleResponse' components: schemas: S3ExportPolicyResponse: type: object properties: items: description: A list of S3 export policy objects. type: array items: $ref: '#/components/schemas/S3ExportPolicy' _builtInNoId: type: object properties: name: description: Name of the object (e.g., a file system or snapshot). type: string 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: 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' S3ExportPolicyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/S3ExportPolicyResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyBaseContext: allOf: - $ref: '#/components/schemas/PolicyBase' - $ref: '#/components/schemas/_context' _referenceNameOnly: type: object properties: name: type: string S3ExportPolicyRuleResponse: type: object description: A list of S3 export policy rule objects. properties: items: type: array items: $ref: '#/components/schemas/S3ExportPolicyRule' PolicyBase: allOf: - $ref: '#/components/schemas/PolicyBaseRenameable' _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 S3ExportPolicyRulePost: type: object properties: actions: description: 'The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is `pure:S3Access`. ' type: array items: type: string example: - pure:S3Access effect: description: 'Effect of this rule. When `allow`, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The currently supported effects are `allow` and `deny`. ' type: string example: allow resources: description: 'The list of resources from the account to which this rule applies to. The only currently supported resource type is buckets. ' type: array items: type: string example: - '*' - mybucket - mybucket* _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 _policyReference: type: object properties: policy: description: The policy to which this rule belongs. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' S3ExportPolicyRule: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_builtInNoId' - $ref: '#/components/schemas/S3ExportPolicyRulePost' - $ref: '#/components/schemas/_policyReference' S3ExportPolicy: allOf: - $ref: '#/components/schemas/PolicyBaseContext' - type: object properties: rules: type: array items: allOf: - $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' - $ref: '#/components/schemas/_policyReference' S3ExportPolicyRuleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/S3ExportPolicyRuleResponse' - $ref: '#/components/schemas/_errorContextResponse' S3ExportPolicyPatch: type: object properties: enabled: type: boolean example: true name: type: string description: New name of the S3 export policy. rules: type: array items: $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' _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 S3ExportPolicyPost: type: object properties: enabled: type: boolean example: true rules: type: array items: $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' _s3ExportPolicyRuleInlined: allOf: - $ref: '#/components/schemas/_referenceNameOnly' - $ref: '#/components/schemas/S3ExportPolicyRulePost' _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 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 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 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 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 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 Names_required: name: names in: query description: 'A comma-separated list of resource names. ' required: true style: form explode: false schema: type: array items: type: string