certificate - Flexible Security Service API References (1.0.0)
Download OpenAPI specification:Download
manage certificate
Get Certificates
Get certificate resources.
Authorizations:
query Parameters
| id | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource. |
| name | string ^[a-zA-Z0-9-_]{1,255}$ A name of the resource. |
| owner | string Enum: "user" "system" Who is the owner of the certificate. |
| tenantId | string ^[a-fA-F0-9]{32}$ ID of the tenant to which the resource belongs. |
| fraGroupId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ ID of the service group to which the resource belongs. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
get/v1/certificates
https://api.ntt.com/fsec-ers/v1/certificates
Response samples
- 200
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "certificates": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "certificate-a",
- "description": "certificate-a",
- "owner": "user",
- "enable": true,
- "expiresAt": "2033-06-01T06:00:00.000Z",
- "checksum": "e1ac5446165bc0cf31e41056bceec6bd719284175777af0a6bb10bd2cf4e9e9d",
- "operationStatus": "COMPLETE",
- "fraGroupId": "12345678-1234-1234-1234-1234567890b1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}, - {
- "id": "12345678-1234-1234-1234-1234567890a2",
- "name": "certificate-b",
- "description": "certificate-b",
- "owner": "system",
- "enable": true,
- "expiresAt": "2033-06-01T06:00:00.000Z",
- "checksum": null,
- "operationStatus": "COMPLETE",
- "fraGroupId": "12345678-1234-1234-1234-1234567890b2",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
]
}Create Certificate
Create certificate resource.
Authorizations:
Request Body schema: application/json
| certificate required | object (CertificateCreateRequest) |
Responses
202
OK
400
Bad Request
401
Unauthorized
409
Conflict
500
Internal Server Error
503
Service Unavailable
post/v1/certificates
https://api.ntt.com/fsec-ers/v1/certificates
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "certificate": {
- "name": "certificate-a",
- "description": "certificate-a",
- "owner": "user",
- "certificate": {
- "dataEncoding": "base64",
- "data": "<encoded_metadata>"
}, - "fraGroupId": "12345678-1234-1234-1234-1234567890b1"
}
}Response samples
- 202
- 400
- 401
- 409
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "certificate": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "certificate-a",
- "description": "certificate-a",
- "owner": "user",
- "enable": true,
- "expiresAt": "2033-06-01T06:00:00.000Z",
- "checksum": "e1ac5446165bc0cf31e41056bceec6bd719284175777af0a6bb10bd2cf4e9e9d",
- "operationStatus": "COMPLETE",
- "fraGroupId": "12345678-1234-1234-1234-1234567890b1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z",
- "operationId": "12345678-1234-1234-1234-1234567890b1"
}
}Get Certificate
Get certificate resource.
Authorizations:
path Parameters
| certificate_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
get/v1/certificates/{certificate_id}
https://api.ntt.com/fsec-ers/v1/certificates/{certificate_id}
Response samples
- 200
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "certificate": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "certificate-a",
- "description": "certificate-a",
- "owner": "user",
- "enable": true,
- "expiresAt": "2033-06-01T06:00:00.000Z",
- "checksum": "e1ac5446165bc0cf31e41056bceec6bd719284175777af0a6bb10bd2cf4e9e9d",
- "operationStatus": "COMPLETE",
- "fraGroupId": "12345678-1234-1234-1234-1234567890b1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}Update Certificate
Update certificate resource.
Authorizations:
path Parameters
| certificate_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Request Body schema: application/json
| certificate required | object (CertificateUpdateRequest) |
Responses
202
OK
400
Bad Request
401
Unauthorized
404
Not Found
409
Conflict
500
Internal Server Error
503
Service Unavailable
patch/v1/certificates/{certificate_id}
https://api.ntt.com/fsec-ers/v1/certificates/{certificate_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "certificate": {
- "description": "certificate-a",
- "enable": true
}
}Response samples
- 202
- 400
- 401
- 404
- 409
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "certificate": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "certificate-a",
- "description": "certificate-a",
- "owner": "user",
- "enable": true,
- "expiresAt": "2033-06-01T06:00:00.000Z",
- "checksum": "e1ac5446165bc0cf31e41056bceec6bd719284175777af0a6bb10bd2cf4e9e9d",
- "operationStatus": "COMPLETE",
- "fraGroupId": "12345678-1234-1234-1234-1234567890b1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z",
- "operationId": "12345678-1234-1234-1234-1234567890b1"
}
}Delete Certificate
Delete certificate resource.
Authorizations:
path Parameters
| certificate_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
202
OK
400
Bad Request
401
Unauthorized
404
Not Found
409
Conflict
500
Internal Server Error
503
Service Unavailable
delete/v1/certificates/{certificate_id}
https://api.ntt.com/fsec-ers/v1/certificates/{certificate_id}
Response samples
- 202
- 400
- 401
- 404
- 409
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "certificate": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "certificate-a",
- "description": "certificate-a",
- "owner": "user",
- "enable": true,
- "expiresAt": "2033-06-01T06:00:00.000Z",
- "checksum": "e1ac5446165bc0cf31e41056bceec6bd719284175777af0a6bb10bd2cf4e9e9d",
- "operationStatus": "COMPLETE",
- "fraGroupId": "12345678-1234-1234-1234-1234567890b1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z",
- "operationId": "12345678-1234-1234-1234-1234567890b1"
}
}Export Certificate file
Export certificate file only when owner is system.
Authorizations:
path Parameters
| certificate_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
get/v1/certificates/{certificate_id}/export
https://api.ntt.com/fsec-ers/v1/certificates/{certificate_id}/export
Response samples
- 200
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "certificateFile": {
- "value": "<encoded_data>",
- "dataEncoding": "base64",
- "checksum": "e1ac5446165bc0cf31e41056bceec6bd719284175777af0a6bb10bd2cf4e9e9d"
}
}