openapi: 3.0.1 info: title: FlashArray REST Active Directory Certificates 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: Certificates description: 'Purity//FA creates a self-signed certificate and private key when you start the system for the first time. You can use the default certificate, change the certificate attributes, create a new self-signed certificate, or import an SSL certificate signed by a certificate authority. ' paths: /api/2.52/certificates: get: tags: - Certificates summary: Pure Storage List Certificate Attributes description: 'Displays certificate attributes. ' 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/CertificateGetResponse' post: tags: - Certificates summary: Pure Storage Create Certificate description: 'Creates a certificate object and specifies the valid time period and organization details of the certificate. A certificate can be imported or manually configured. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificatePost' required: true x-codegen-request-body-name: certificate responses: '200': description: Returns the newly created certificate object. content: application/json: schema: $ref: '#/components/schemas/CertificateResponse' x-codegen-request-body-name: certificate delete: tags: - Certificates summary: Pure Storage Delete Certificate description: 'Deletes a specific certificate object. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Certificates summary: Pure Storage Modify Certificates description: 'Modifies certificate attributes. Modifying self-signed certificate attributes replaces the existing certificate with a new one, generated by Purity//FA, using the specified attributes. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Generate_new_key' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificatePost' required: true x-codegen-request-body-name: certificate responses: '200': description: Returns the newly updated certificate object. content: application/json: schema: $ref: '#/components/schemas/CertificateResponse' x-codegen-request-body-name: certificate /api/2.52/certificates/certificate-groups: get: tags: - Certificates summary: Pure Storage List Certificates and Certificate-groups description: 'Lists membership associations between groups and certificates. ' 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/CertificateCertificateGroupGetResponse' post: tags: - Certificates summary: Pure Storage Create Certificates Orcertificate-groups description: 'Creates one or more certificates to 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: application/json: schema: $ref: '#/components/schemas/CertificateCertificateGroupResponse' delete: tags: - Certificates summary: Pure Storage Deletes Certificates/certificate-groups description: 'Deletes one or more certificates from 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/certificates/uses: get: tags: - Certificates summary: Pure Storage List Certificates Uses description: 'Displays the usage and associations of certificates. ' 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/CertificateUseGetResponse' /api/2.52/certificates/certificate-signing-requests: post: tags: - Certificates summary: Pure Storage Create Certificate-signing-requests description: 'Creates a certificate signing request using a specified certificate and parameters. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificateSigningRequestPost' required: true x-codegen-request-body-name: certificate responses: '200': description: Returns the newly created certificate object. content: application/json: schema: $ref: '#/components/schemas/CertificateSigningRequestResponse' x-codegen-request-body-name: certificate /api/2.26/certificates: get: tags: - Certificates summary: Pure Storage GET Certificates description: List array certificates and their attributes. 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/CertificateGetResponse' post: tags: - Certificates summary: Pure Storage POST Certificates description: 'Either upload a CA certificate to the array, upload a new appliance certificate with a private key, or generate a new self-signed certificate with a new private key and the specified attributes. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificatePost_2' required: true x-codegen-request-body-name: certificate 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/CertificateResponse_2' x-codegen-request-body-name: certificate delete: tags: - Certificates summary: Pure Storage DELETE Certificates description: Delete a CA certificate 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: {} patch: tags: - Certificates summary: Pure Storage PATCH Certificates description: 'Modify SSL certificate attributes such as importing a new certificate and private key, or change intermediate certificate chains. Alternatively, generate a new self-signed certificate with specified properties to overwrite an existing certificate, and optionally generate a new private key. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Generate_new_key' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificatePatch' required: true x-codegen-request-body-name: certificate 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/CertificateResponse_2' x-codegen-request-body-name: certificate /api/2.26/certificates/certificate-groups: get: tags: - Certificates summary: Pure Storage GET Certificates/certificate-groups description: List membership associations between groups and certificates. 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/CertificateCertificateGroupGetResp' post: tags: - Certificates summary: Pure Storage POST Certificates/certificate-groups description: Add one or more certificates to 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: application/json: schema: $ref: '#/components/schemas/CertificateCertificateGroupResponse_2' delete: tags: - Certificates summary: Pure Storage DELETE Certificates/certificate-groups description: Remove one or more certificates from 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/certificates/certificate-signing-requests: post: tags: - Certificates summary: Pure Storage Create Certificate-signing-requests description: 'Creates a certificate signing request using a specified certificate and parameters. ' parameters: - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificateSigningRequestPost_2' required: true x-codegen-request-body-name: certificate 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/CertificateSigningRequestResponse_2' x-codegen-request-body-name: certificate /api/2.26/certificates/uses: get: tags: - Certificates summary: Pure Storage GET Certificates/uses description: List how certificates 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/CertificateUseGetResponse' components: schemas: CertificatePatch: allOf: - $ref: '#/components/schemas/_certificateBase_2' - type: object properties: days: description: 'The number of days that the self-signed certificate is valid. Defaults to 3650. This field can only be specified when creating a new self-signed certificate. ' type: integer format: int32 example: 3650 passphrase: description: 'The passphrase used to encrypt `private_key`. This field can only be specified when importing a certificate and key pair. ' type: string private_key: description: 'The text of the private key. This field can only be specified when importing a certificate and key pair. ' type: string _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' _referenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string _certificateBase_2: allOf: - $ref: '#/components/schemas/_realmsReference' - type: object properties: certificate: description: The text of the certificate. type: string certificate_type: description: 'The type of certificate. Possible values are `appliance` and `external`. Certificates of type `appliance` are used by the array to verify its identity to clients. Certificates of type `external` are used by the array to identify external servers to which it is configured to communicate. This field may only be specified at certificate creation time. If not specified at creation time, defaults to `external`. ' type: string common_name: description: The common name field listed in the certificate. type: string country: description: The country field listed in the certificate. type: string example: Canada email: description: The email field listed in the certificate. type: string example: tcrisp@example.com intermediate_certificate: description: Intermediate certificate chains. type: string issued_by: description: Who issued this certificate. type: string readOnly: true example: Example Incorporated issued_to: description: Who this certificate was issued to. type: string readOnly: true example: Pure Storage, Inc. key_algorithm: description: 'The key algorithm used to generate the certificate. This field can only be specified when creating a new self-signed certificate. Defaults to `rsa` if not specified. Valid values when creating a new self-signed certificate only include `rsa`, `ec`, `ed448` and `ed25519`. ' type: string example: rsa key_size: description: 'The size (in bits) of the private key for the certificate. Default is 2048 bits for `rsa` key_algorithm, 256 for `ec` and `ed25519`. The `ed448` default key size is 456. This field can only be specified when creating a new self-signed certificate. ' type: integer format: int32 example: 2048 locality: description: The locality field listed in the certificate. type: string example: Toronto organization: description: The organization field listed in the certificate. type: string example: Veridian Dynamics organizational_unit: description: The organizational unit field listed in the certificate. type: string example: Research & Development state: description: The state/province field listed in the certificate. type: string example: Ontario status: description: 'The type of certificate. Valid values are `self-signed` and `imported`. ' type: string readOnly: true subject_alternative_names: description: 'The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs. ' type: array items: type: string example: otherdnsname.mydomain.com valid_from: description: 'The date when the certificate starts being valid. ' type: integer format: int64 readOnly: true example: 1491070899000 valid_to: description: 'The date when the certificate stops being valid. ' type: integer format: int64 readOnly: true example: 152424849000 _memberWithType: type: object properties: group: $ref: '#/components/schemas/_referenceWithType' member: $ref: '#/components/schemas/_referenceWithType' CertificateCertificateGroupResponse_2: type: object properties: items: description: 'A list of certificate and certificate group relationships. ' type: array items: $ref: '#/components/schemas/Member' _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 _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 CertificateCertificateGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CertificateCertificateGroupResponse' _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 CertificateSigningRequest: description: 'SSL certificate managed by Purity//FA. ' type: object properties: certificate_signing_request: description: 'The text of a new certificate signing request. ' type: string CertificateSigningRequest_2: description: 'SSL certificate managed by Purity. ' type: object properties: certificate_signing_request: description: 'The text of a new certificate signing request. ' type: string _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 CertificateSigningRequestPost: description: SSL Certificate managed by Purity//FA. type: object properties: certificate: $ref: '#/components/schemas/_referenceNoId' common_name: description: The common name field listed in the certificate. type: string example: Pure Storage Inc. country: description: Two-letter country (ISO) code listed in the certificate. type: string example: CA email: description: The email field listed in the certificate. type: string example: tcrisp@veridiandynamics.com locality: description: The locality field listed in the certificate. type: string example: Toronto organization: description: The organization field listed in the certificate. type: string example: Veridian Dynamics organizational_unit: description: The organizational unit field listed in the certificate. type: string example: Research & Development state: description: The state/province field listed in the certificate. type: string example: Ontario subject_alternative_names: description: 'The alternative names that are secured by this certificate. Alternative names include IP addresses, DNS names, or URIs. ' type: array items: type: string example: otherdnsname.mydomain.com Certificate_2: allOf: - description: SSL Certificate managed by Purity. - $ref: '#/components/schemas/_builtIn_2' - $ref: '#/components/schemas/_certificateBase_2' CertificateResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Certificate' CertificateCertificateGroupGetResp: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/CertificateCertificateGroupResponse_2' CertificatePost_2: allOf: - $ref: '#/components/schemas/_certificateBase_2' - type: object properties: days: description: 'The number of days that the self-signed certificate is valid. Defaults to 3650. This field can only be specified when creating a new self-signed certificate. ' type: integer format: int32 example: 3650 passphrase: description: 'The passphrase used to encrypt `private_key`. This field can only be specified when importing a certificate and key pair. ' type: string private_key: description: 'The text of the private key. This field can only be specified when importing a certificate and key pair. ' type: string _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 CertificateUse: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: group: description: 'A reference to the certificate group that is being used, if any, where this certificate is a member of the certificate-group. Returns `null` if the referenced user object is not associated with a group and is directly using this certificate. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' use: description: A reference to an object using this certificate. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' Certificate: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_certificateBase' - type: object CertificatePost: allOf: - $ref: '#/components/schemas/_certificateBase' - type: object properties: days: description: 'The number of days that the self-signed certificate is valid. Defaults to 3650. This field can only be specified when creating a new self-signed certificate. ' type: integer format: int32 example: 3650 key: description: 'The text of the private key. This field can only be specified when importing a certificate and key pair. ' type: string passphrase: description: 'The passphrase used to encrypt `key`. This field can only be specified when importing a certificate and key pair. ' type: string CertificateResponse_2: type: object properties: items: description: A list of certificate objects. type: array items: $ref: '#/components/schemas/Certificate_2' CertificateSigningRequestResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CertificateSigningRequest' _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 CertificateUseGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: A list of certificate use objects. type: array items: $ref: '#/components/schemas/CertificateUse' _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 _certificateBase: description: SSL certificate managed by Purity. type: object properties: certificate: description: 'The text of the certificate. ' type: string certificate_type: description: 'The type of certificate. Values include `appliance` and `external`. Certificates of type `appliance` are used by the array to verify its identity to clients. Certificates of type `external` are used by the array to identify external servers to which it is configured to communicate. ' type: string readOnly: true common_name: description: 'The common name field listed in the certificate. ' type: string example: Pure Storage Inc. country: description: 'Two-letter country (ISO) code listed in the certificate. ' type: string example: CA email: description: 'The email field listed in the certificate. ' type: string example: tcrisp@veridiandynamics.com intermediate_certificate: description: 'The text of the intermediate certificate chains. ' type: string issued_by: description: 'The party that issued the certificate. ' type: string readOnly: true example: Symantec, Inc. issued_to: description: 'The party to whom the certificate is issued. ' type: string readOnly: true example: Pure Storage, Inc. key_algorithm: description: 'The key algorithm used to generate the certificate. This field can only be specified when creating a new self-signed certificate. Defaults to rsa if not specified. Valid values when creating a new self-signed certificate only include `rsa`, `ec`, `ed448` and `ed25519`. ' type: string example: rsa key_size: description: 'The size (in bits) of the private key for the certificate. Default is 2048 bits for `rsa` key_algorithm, 256 for `ec` and `ed25519`. The `ed448` default key size is 456. This field can only be specified when creating a new self-signed certificate. ' type: integer format: int32 example: 2048 locality: description: 'The locality field listed in the certificate. ' type: string example: Toronto organization: description: 'The organization field listed in the certificate. ' type: string example: Veridian Dynamics organizational_unit: description: 'The organizational unit field listed in the certificate. ' type: string example: Research & Development state: description: 'The state/province field listed in the certificate. ' type: string example: Ontario status: description: 'The type of certificate. Valid values are `self-signed` and `imported`. ' type: string readOnly: true subject_alternative_names: description: 'The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs. ' type: array items: type: string example: otherdnsname.mydomain.com valid_from: description: 'The date when the certificate starts being valid. ' type: integer format: int64 readOnly: true example: 1491070899 valid_to: description: 'The date when the certificate stops being valid. ' type: integer format: int64 readOnly: true example: 1524248499 CertificateSigningRequestPost_2: description: A request to create a CSR for a Purity//FB certificate object. type: object properties: certificate: description: 'The certificate object whose private key will be used for generating the CSR, and whose certificate will be overwritten if the CSR is signed and imported back into FlashBlade. ' title: Reference allOf: - $ref: '#/components/schemas/_reference_2' common_name: description: The common name field to be listed in the certificate. type: string example: Pure Storage Inc. country: description: Two-letter country (ISO) code to be listed in the certificate. type: string example: CA email: description: The email field to be listed in the certificate. type: string example: tcrisp@veridiandynamics.com locality: description: The locality field to be listed in the certificate. type: string example: Toronto organization: description: The organization field to be listed in the certificate. type: string example: Veridian Dynamics organizational_unit: description: The organizational unit field to be listed in the certificate. type: string example: Research & Development state: description: The state/province field to be listed in the certificate. type: string example: Ontario subject_alternative_names: description: 'The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs. Specifying these will encode them in the certificate signing request; however, it is the decision of the signing authority as to whether or not they will be honored or ignored. ' type: array items: type: string example: otherdnsname.mydomain.com CertificateCertificateGroupResponse: type: object properties: items: description: 'A list of certificate and certificate group relationships. ' type: array items: $ref: '#/components/schemas/_memberWithType' 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 CertificateSigningRequestResponse_2: type: object properties: items: type: array items: $ref: '#/components/schemas/CertificateSigningRequest_2' description: A list of certificate signing request objects. _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 _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' CertificateGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CertificateResponse' 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 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 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 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 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 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 Generate_new_key: name: generate_new_key in: query description: 'If set to `true`, a new private key is generated when generating a new certificate with the specified attributes. This may not be set to `true` when importing a certificate and private key, and may not be set to `false` when generating a new self-signed certificate to replace a certificate that was imported. Default setting is `false`. ' schema: type: boolean 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