Documentation Powered by ReDoc

Certificate-Profile - Flexible Secure Gateway API References (1.13.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

Certificate-Profile resource.

Authentication

X-Auth-Token

Security Scheme Type API Key
Header parameter name: X-Auth-Token

certificate-profile

Get Certificate-Profiles

Get Certificate-Profile resources.

Authorizations:
X-Auth-Token
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-Z]{1}[a-zA-Z0-9-\_]{0,30}$

A name of the resource.

cellGroupId
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The Cell-Group ID which the resource belongs.

_limit
integer >= 1

The maximum number of items to return.

_offset
integer >= 0

The number of items to skip before starting to return results.

_order_by
string
Enum: "id" "name" "cellGroupId" "tenantId" "createdAt" "updatedAt"

Sort key.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/certificate-profiles
https://api.ntt.com/dsigw-erg/v1/certificate-profiles

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificateProfiles":
    [
    ]
}

Create Certificate-Profile

Create a Certificate-Profile resource.

Authorizations:
X-Auth-Token
header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
certificateProfile
required
object (CertificateProfileCreateRequest)

Certificate-Profile create request schema.

Responses

201

Created

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1/certificate-profiles
https://api.ntt.com/dsigw-erg/v1/certificate-profiles

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificateProfile":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificateProfile":
    {
    }
}

Get Certificate-Profile Details

Get a Certificate-Profile resource.

Authorizations:
X-Auth-Token
path Parameters
certificate_profile_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Certificate-Profile resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/certificate-profiles/{certificate_profile_id}
https://api.ntt.com/dsigw-erg/v1/certificate-profiles/{certificate_profile_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificateProfile":
    {
    }
}

Update Certificate-Profile

Update a Certificate-Profile resource.

Authorizations:
X-Auth-Token
path Parameters
certificate_profile_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Certificate-Profile resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
certificateProfile
required
object (CertificateProfileUpdateRequest)

Certificate-Profile update request schema.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/certificate-profiles/{certificate_profile_id}
https://api.ntt.com/dsigw-erg/v1/certificate-profiles/{certificate_profile_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificateProfile":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificateProfile":
    {
    }
}

Delete Certificate-Profile

Delete a Certificate-Profile resource.

Authorizations:
X-Auth-Token
path Parameters
certificate_profile_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Certificate-Profile resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/certificate-profiles/{certificate_profile_id}
https://api.ntt.com/dsigw-erg/v1/certificate-profiles/{certificate_profile_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 400,
  • "errorMessage": "Invalid request",
  • "moreInfo": "{{moreInfo}}"
}

Create Certificate

Create Certificate resources in a Certificate-Profile.

Authorizations:
X-Auth-Token
path Parameters
certificate_profile_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Certificate-Profile resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
certificates
required
Array of objects (CertificateCreateRequest) [ 1 .. 10 ] items

List of certificates to create.

Responses

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

post/v1/certificate-profiles/{certificate_profile_id}/certificates
https://api.ntt.com/dsigw-erg/v1/certificate-profiles/{certificate_profile_id}/certificates

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificates":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificates":
    [
    ],
  • "operationId": "715ee526-1c17-44c4-822d-c3c044babfe8"
}

Update Certificate

Update a Certificate resource.

Authorizations:
X-Auth-Token
path Parameters
certificate_profile_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Certificate-Profile resource.

certificate_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Certificate resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
certificate
required
object (CertificateUpdateRequest)

Certificate update request schema.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/certificate-profiles/{certificate_profile_id}/certificates/{certificate_id}
https://api.ntt.com/dsigw-erg/v1/certificate-profiles/{certificate_profile_id}/certificates/{certificate_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificate":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificate":
    {
    }
}

Delete Certificate

Delete a Certificate resource.

Authorizations:
X-Auth-Token
path Parameters
certificate_profile_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Certificate-Profile resource.

certificate_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Certificate resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/certificate-profiles/{certificate_profile_id}/certificates/{certificate_id}
https://api.ntt.com/dsigw-erg/v1/certificate-profiles/{certificate_profile_id}/certificates/{certificate_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 400,
  • "errorMessage": "Invalid request",
  • "moreInfo": "{{moreInfo}}"
}