openapi: 3.0.1 info: title: FlashArray REST Active Directory Administrators 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: Administrators description: 'The FlashArray has a single default administrative account named pureuser. The administrator can add, delete, and modify administrators on the array. Administrators are assigned management access policies to give different levels of permissions. ' paths: /api/2.52/admins: get: tags: - Administrators summary: Pure Storage List Administrators description: 'Displays a list of administrators. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Expose_api_token' - $ref: '#/components/parameters/Expose_public_key' - $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 content: application/json: schema: $ref: '#/components/schemas/AdminGetResponse' post: tags: - Administrators summary: Pure Storage Create an Administrator description: 'Creates an administrator. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminPost' required: true x-codegen-request-body-name: admin responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminResponse' x-codegen-request-body-name: admin delete: tags: - Administrators summary: Pure Storage Delete an Administrator description: 'Deletes the specified administrator. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Administrators summary: Pure Storage Modify an Administrator description: 'Modifies properties for the specified administrator. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminPatch' required: true x-codegen-request-body-name: admin responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminResponse' x-codegen-request-body-name: admin /api/2.52/admins/policies/management-access: get: tags: - Administrators summary: Pure Storage List Management Access Policies Attached to Administrators description: 'Displays a list of management access policies that are attached to administrators. ' parameters: - $ref: '#/components/parameters/Authorization' - $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/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanGetResponse' '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/PolicyMemberCleanGetResponse' post: tags: - Administrators summary: Pure Storage Create a Membership Between an Administrator with One or More Management Access Policies. description: 'Creates a membership between an administrator with one or more management access policies. One of `member_ids` or `member_names` parameter is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyAssignmentPost' required: true x-codegen-request-body-name: policies responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanResponse' x-codegen-request-body-name: policies delete: tags: - Administrators summary: Pure Storage Delete a Membership Between an Administrator and One or More Management Access Policies description: 'Deletes a membership between an administrator with one or more management access policies. One of `policy_ids` or `policy_names` is required, and one of `member_ids` or `member_names` is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/admins/api-tokens: get: tags: - Administrators summary: Pure Storage List API Tokens description: Displays API tokens for the specified administrators. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Expose_api_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 content: application/json: schema: $ref: '#/components/schemas/AdminApiTokenGetResponse' post: tags: - Administrators summary: Pure Storage Create API Tokens description: Creates API tokens for the specified administrators. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Timeout' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminApiTokenResponse' delete: tags: - Administrators summary: Pure Storage Delete API Tokens description: Deletes the API tokens of the specified administrators. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} /api/2.52/admins/cache: get: tags: - Administrators summary: Pure Storage List Administrator Cache Entries description: 'Displays entries in the administrator cache. ' 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/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/AdminCacheGetResponse' put: tags: - Administrators summary: Pure Storage Update or Refresh Entries in the Administrator Cache description: 'Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminCacheResponse' delete: tags: - Administrators summary: Pure Storage Delete Cache Entries description: 'Deletes all entries from the administrator cache. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Remove_all_entries' responses: '200': description: OK content: {} /api/2.52/admins/settings: get: tags: - Administrators summary: Pure Storage List Administrator Settings description: 'Displays the global administrator settings for the array. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/AdminSettingsGetResponse' patch: tags: - Administrators summary: Pure Storage Modify Administrator Settings description: 'Modifies the global administrator settings for the array. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminSettings' required: true x-codegen-request-body-name: admin-settings responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminSettingsResponse' x-codegen-request-body-name: admin-settings /api/2.26/admins: get: tags: - Administrators summary: Pure Storage GET Admins description: List the administrator's attributes, including the API token and public key. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Expose_api_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $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/AdminGetResponse_2' '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/AdminGetResponse_2' post: tags: - Administrators summary: Pure Storage POST Admins description: Create a new local administrator. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminPost_2' required: true x-codegen-request-body-name: admin 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/AdminResponse_2' x-codegen-request-body-name: admin delete: tags: - Administrators summary: Pure Storage DELETE Admins description: Delete a local administrator.. 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: - Administrators summary: Pure Storage PATCH Admins description: Modify the attributes of an administrator. 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/AdminPatch_2' required: true x-codegen-request-body-name: admin 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/AdminResponse_2' x-codegen-request-body-name: admin /api/2.26/admins/api-tokens: get: tags: - Administrators summary: Pure Storage GET Admins/api-tokens description: Displays API tokens for the specified administrators. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Admin_ids' - $ref: '#/components/parameters/Admin_names' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Expose_api_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/AdminApiTokenGetResponse_2' '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/AdminApiTokenGetResponse_2' post: tags: - Administrators summary: Pure Storage POST Admins/api-tokens description: Creates API tokens for the specified administrators. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Admin_ids' - $ref: '#/components/parameters/Admin_names' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Timeout' 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/AdminApiTokenResponse_2' delete: tags: - Administrators summary: Pure Storage DELETE Admins/api-tokens description: Deletes the API tokens of the specified administrators. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Admin_ids' - $ref: '#/components/parameters/Admin_names' - $ref: '#/components/parameters/Context_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/admins/cache: get: tags: - Administrators summary: Pure Storage GET Admins/cache description: List cached administrator information used to determine role based access control privileges. 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_2' - $ref: '#/components/parameters/Refresh' - $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/AdminCacheGetResponse_2' '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/AdminCacheGetResponse_2' delete: tags: - Administrators summary: Pure Storage DELETE Admins/cache description: Delete cached administrator role information by name or ID. 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: {} /api/2.26/admins/settings: get: tags: - Administrators summary: Pure Storage List Global Admin Settings description: Return global admin settings. parameters: - $ref: '#/components/parameters/XRequestId' - $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/AdminSettingsGetResponse_2' patch: tags: - Administrators summary: Pure Storage Update Global Admin Settings description: Update properties for global admin settings. parameters: - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminSetting' required: true x-codegen-request-body-name: admin-setting 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/AdminSettingsResponse_2' x-codegen-request-body-name: admin-setting components: schemas: _apiToken: description: API token type: object properties: created_at: description: Creation time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true expires_at: description: Expiration time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true token: type: string readOnly: true x-readOnly: true AdminCacheResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AdminCache' _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 AdminApiToken_2: allOf: - $ref: '#/components/schemas/_context_2' - type: object properties: admin: description: A reference to the admin to whom this token belongs. title: Reference allOf: - $ref: '#/components/schemas/_reference_2' api_token: title: ApiToken allOf: - $ref: '#/components/schemas/_apiToken' x-readOnly: true AdminPost_2: description: 'An administrative user, who has rights to login and manage the array in some capacity. ' type: object properties: admin_type: description: 'The type of admin account. Set to `service-account` to create a REST-only service account. Service accounts do not have passwords and cannot have associated public keys. If not specified, defaults to `local-user`. ' type: string example: service-account management_access_policies: description: 'List of management access policies associated with the administrator. ' type: array items: $ref: '#/components/schemas/_referenceWritable' password: description: New user password. type: string public_key: description: Public key for SSH access. Supported key types include `Ed25519` and `RSA`. type: string role: description: 'Deprecated. `role` is deprecated in favor of `management_access_policies`, but remains for backwards compatibility. If an administrator has exactly one access policy which corresponds to a valid legacy role of the same name, `role` will be a reference to that role. Otherwise, it will be `null`. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' _builtIn: 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 AdminApiTokenResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AdminApiToken' AdminGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AdminResponse' AdminApiTokenGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/AdminApiTokenResponse_2' - $ref: '#/components/schemas/_errorContextResponse_2' PolicyMemberCleanGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberCleanResponse' - $ref: '#/components/schemas/_errorContextResponse' AdminSettingsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AdminSettings' PolicyAssignmentPost: type: object properties: policies: description: 'A list of policies to apply to the resource. One of `id` or `name` is required in each `policy`. ' type: array items: $ref: '#/components/schemas/PolicyAssignmentPostPolicy' AdminApiTokenGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AdminApiTokenResponse' AdminSetting: type: object properties: lockout_duration: description: 'The lockout duration, in milliseconds, if a user has reached the maximum number of login attempts. Ranges from 1 second to 90 days. Default value is `null`. Use 0 to reset the value to `null`. ' type: integer format: int64 minimum: 0 maximum: 7776000000 example: 3600000 max_login_attempts: description: 'The maximum number of failed login attempts allowed before the user is locked out. Default value is `null`. Use 0 to reset the value to `null`. ' type: integer format: int32 minimum: 0 maximum: 100 example: 10 min_password_length: description: 'The minimum password length. If not specified, defaults to 1 character. ' type: integer format: int32 minimum: 1 maximum: 100 example: 1 PolicyMemberCleanResponse: type: object properties: items: description: 'Displays a list of all items after filtering. The values are displayed for each name, if meaningful. ' type: array items: $ref: '#/components/schemas/PolicyMemberClean' AdminSettingsResponse_2: type: object properties: items: description: Returns global admin settings. type: array items: $ref: '#/components/schemas/AdminSetting' _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 _referenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string AdminCache: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - description: 'A cache entry for the admin cache to quickly look up admin roles. ' type: object properties: authorization_model: description: 'The source of the access policy mapping. A value of `static` indicates that policies are configured locally on the array, while a value of `dynamic` indicates that they are determined by an external system such as `LDAP` or an `IdP`. ' type: string example: static cached_at: description: 'Time when the entry was added to the cache, in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true management_access_policies: description: 'List of management access policies associated with the administrator. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' role: title: AdminRole allOf: - $ref: '#/components/schemas/_adminRole' Admin: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - description: Administrator account. type: object properties: admin_type: description: 'The type of administrative account. A value of `local-user` indicates the account is managed directly on the array, while `remote-user` indicates the account is provisioned by an external system such as `LDAP` or `SAML`. ' type: string readOnly: true example: local-user api_token: $ref: '#/components/schemas/_apiToken' authorization_model: description: 'The source of the access policy mapping. A value of `static` indicates that policies are configured locally on the array, while a value of `dynamic` indicates that they are determined by an external system such as `LDAP` or an `IdP`. ' type: string example: static is_local: description: 'Returns a value of `true` if the user is local to the machine. ' type: boolean readOnly: true example: true locked: description: 'Returns a value of `true` if the user is currently locked out. otherwise `false`. Change to `false` to unlock a user. This field is only visible to `array_admin` roles. For all other users, the value is always `null`. ' type: boolean example: false lockout_remaining: description: 'The remaining lockout period if the user is locked out, in milliseconds. This field is only visible to `array_admin` roles. For all other users, the value is always `null`. ' type: integer format: int64 readOnly: true management_access_policies: description: 'List of management access policies associated with the administrator. ' type: array items: $ref: '#/components/schemas/_referenceWithType' password: description: 'Password associated with the account. ' type: string public_key: description: 'Public key for SSH access. Multiple public keys can be specified, separated by newlines. ' type: string role: $ref: '#/components/schemas/_adminRole' _adminSettingsRequiredAuthenticationMethods: description: 'Authentication methods that are required for the array on specific user interfaces. ' type: object properties: ssh: description: 'List of authentication methods that are required for SSH. Possible values include `password`, `key`, and `default`. `securid-am` is a possible value, but it cannot be changed through PATCH. If not specified, defaults to `default`. Specify `password` and `key` authentication methods to set up local multi-factor authentication for SSH. ' type: array items: type: string description: 'Authentication method required for SSH. ' example: - password - key web_ui: description: 'List of authentication methods that are required for the web UI. Possible values include `password`, `webauthn`, and `default`. Other possible values include `saml2` and `securid-am` but these cannot be changed through PATCH. If not specified, defaults to `default`. Specify `password` and `webauthn` authentication methods to set up local multi-factor authentication for web UI. External multi-factor authentication is configured through SAML2 SSO endpoints. ' type: array items: type: string description: 'Authentication method required for the web UI. ' example: - password - webauthn _fixedNameResourceNoId: description: 'An ordinary (as opposed to built-in) resource that can be created, named, or deleted by the user. This might be a virtual resource (e.g., a volume) or correspond to something in the environment, like a host or server. ' type: object properties: name: description: 'A user-specified name. The name must be locally unique and cannot be changed. ' type: string readOnly: true AdminPost: type: object properties: management_access_policies: description: 'List of management access policies to associate with the administrator. Policies can be specified by the `name` or `ID` parameter, but they cannot be set together. ' type: array items: $ref: '#/components/schemas/_referenceWithType' password: description: 'Password associated with the account. ' type: string role: $ref: '#/components/schemas/_adminRole' _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 AdminCache_2: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context_2' - type: object properties: authorization_model: description: 'The location for access policies mapping. Returns `static` if they''re configured locally on the array. Otherwise, `dynamic` is returned, indicating they''re decided by an external system e.g. LDAP, IDP. ' type: string readOnly: true example: static management_access_policies: description: 'List of management access policies associated with the administrator. ' readOnly: true type: array items: $ref: '#/components/schemas/_fixedReference_2' role: description: 'Deprecated. `role` is deprecated in favor of `management_access_policies`, but remains for backwards compatibility. If an administrator has exactly one access policy which corresponds to a valid legacy role of the same name, `role` will be a reference to that role. Otherwise, it will be `null`. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' time: description: 'Time the role was cached in milliseconds since UNIX epoch. ' type: integer format: int64 readOnly: true x-readOnly: true PolicyAssignmentPostPolicy: type: object properties: policy: description: 'Reference to the policy to apply to the resource. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' Admin_2: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context_2' - type: object properties: admin_type: description: 'The type of admin account. Valid values include `local-user`, `remote-user`, `service-account`. A `local-user` is managed directly on the array. A `remote-user` is provisioned by an external system such as LDAP or SAML. A `service-account` is a local account intended only for REST API access. ' type: string readOnly: true example: local-user api_token: $ref: '#/components/schemas/_apiToken' authorization_model: description: 'The location for access policies mapping. Returns `static` if they''re configured locally on the array. Otherwise, `dynamic` is returned, indicating they''re decided by an external system e.g. LDAP, IDP. ' type: string example: static is_local: description: Returns a value of `true` if the user is local to the machine, otherwise `false`. type: boolean readOnly: true locked: description: 'Returns a value of `true` if the user is currently locked out, otherwise `false`. Can be patched to false to unlock a user. This field is only visible to `array_admin` roles. For all other users, the value is always `null`. ' type: boolean example: false lockout_remaining: description: 'The remaining lockout period, in milliseconds, if the user is locked out. This field is only visible to `array_admin` roles. For all other users, the value is always `null`. ' type: integer format: int64 readOnly: true management_access_policies: description: 'List of management access policies associated with the administrator. ' type: array items: $ref: '#/components/schemas/_fixedReference_2' public_key: description: Public key for SSH access. Supported key types are `Ed25519` and `RSA`. type: string role: description: 'Deprecated. `role` is deprecated in favor of `management_access_policies`, but remains for backwards compatibility. If an administrator has exactly one access policy which corresponds to a valid legacy role of the same name, `role` will be a reference to that role. Otherwise, it will be `null`. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' AdminApiToken: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - description: Administrative account API token. type: object properties: api_token: $ref: '#/components/schemas/_apiToken' 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 _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' _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 AdminPatch: allOf: - $ref: '#/components/schemas/Admin' - type: object properties: old_password: description: 'The current password. ' type: string AdminGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/AdminResponse_2' - $ref: '#/components/schemas/_errorContextResponse_2' _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 _errorContextResponse_2: 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' AdminSettings: description: Global settings for administrative accounts. type: object properties: lockout_duration: description: 'The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days. ' type: integer format: int64 minimum: 1000 maximum: 7776000000 example: 3600000 max_login_attempts: description: 'Maximum number of failed login attempts allowed before the user is locked out. ' type: integer format: int32 minimum: 1 maximum: 20 example: 10 min_password_length: description: 'Minimum password length. If not specified, defaults to 1. ' type: integer format: int32 example: 1 required_authentication_methods: $ref: '#/components/schemas/_adminSettingsRequiredAuthenticationMethods' single_sign_on_enabled: description: 'If `true`, then single sign-on is enabled for the array. ' type: boolean example: true _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 AdminSettingsGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/AdminSettingsResponse_2' _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' _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' _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 AdminSettingsGetResponse: allOf: - $ref: '#/components/schemas/AdminSettingsResponse' - type: object properties: 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 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 AdminPatch_2: type: object properties: authorization_model: description: 'The location for access policies mapping. Returns `static` if they''re configured locally on the array. Otherwise, `dynamic` is returned, indicating they''re decided by an external system e.g. LDAP, IDP. ' type: string locked: description: 'If set to `false`, the specified user is unlocked. Setting to `true` is not allowed. ' type: boolean example: false management_access_policies: description: 'List of management access policies associated with the statically-authorized administrator. It''s only used when converting remote users from dynamically- to be statically-authorized. ' type: array items: $ref: '#/components/schemas/_referenceWritable' old_password: description: Old user password. type: string password: description: New user password. type: string public_key: description: Public key for SSH access. Supported key types are `Ed25519` and `RSA`. type: string role: description: 'Deprecated. `role` is deprecated in favor of `management_access_policies`, but remains for backwards compatibility. If an administrator has exactly one access policy which corresponds to a valid legacy role of the same name, `role` will be a reference to that role. Otherwise, it will be `null`. If `role` is `null`, then attempts to patch it will fail in order to prevent legacy operations from overwriting administrator configurations utilizing newer policies. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' _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_2' message: description: A description of the error which occurred. type: string example: Resource does not exist. _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 PolicyMemberClean: allOf: - $ref: '#/components/schemas/_context' - type: object properties: member: description: 'Reference to the resource that the policy is applied to. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' policy: description: 'Reference to the policy. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _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 AdminApiTokenResponse_2: type: object properties: items: description: A list of administrator API tokens. type: array items: $ref: '#/components/schemas/AdminApiToken_2' AdminCacheGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AdminCacheResponse' _adminRole: allOf: - $ref: '#/components/schemas/_referenceNoId' - description: 'This field has been deprecated. Predecessor to management access policies. ' type: object AdminResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Admin' AdminResponse_2: type: object properties: items: description: A list of administrative account objects. type: array items: $ref: '#/components/schemas/Admin_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 AdminCacheGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: description: A list of admin cache entries. type: array items: $ref: '#/components/schemas/AdminCache_2' parameters: Admin_names: name: admin_names in: query description: 'A comma-separated list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with `admin_ids` query parameter. ' style: form explode: false schema: type: array items: type: string Timeout: name: timeout in: query description: 'The duration of API token validity, in milliseconds. ' schema: type: integer format: int64 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 Expose_public_key: name: expose_public_key in: query description: 'If `true`, exposes the public key of the current user. ' schema: type: boolean 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 Expose_api_token: name: expose_api_token in: query description: 'If `true`, exposes the API token of the current user. ' schema: type: boolean Admin_ids: name: admin_ids in: query description: 'A comma-separated list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the `admin_names` query parameter. ' style: form explode: false schema: type: array items: type: string 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 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: 'Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together. ' 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 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 Member_names: name: member_names in: query description: 'Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`. ' 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 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 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 Policy_names: name: policy_names in: query description: 'Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`. ' 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 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 Member_ids: name: member_ids in: query description: 'Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together. ' 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 Refresh: name: refresh in: query description: 'Whether to refresh the user info from directory service. If not specified, defaults to `false`. ' schema: type: boolean 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 Remove_all_entries: name: remove_all_entries in: query description: 'If set to `true`, removes all entries from the administrator cache. ' required: true schema: type: boolean