Smart Data Platform SSS API v2 List (3.0.0)

Download OpenAPI specification:Download

Introduction

Smart Data Platform SSS (Shared Support Service) provides controls of your contract / user / tenant / API keys and permissions. Following list shows SSS API v2.

Notes

Some API cannot be used / requires differenct parameter for contracts applied Smart Data Platform via NTT Communications business portal.
HTTP Response header name is case insensitive.

Authentication

SSS APIs require authentication with "Keystone", which is API authenticator defaults to Openstack.

X-Auth-Token

A Token you can get from Keystone. Set this token in request header as "X-Auth-Token" to request SSS APIs. To get this token please follow this link.

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

User API

API for manage user(s).

Get User information

⚠️ This API returns empty login id and email when requested to the regions except user's home region.

Overview

Lists IDs, names, and links for all servers Get user information such as login id, email, apikey etc.

Classification

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

user's id (ecidXXXXXXXXX)

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecid1000005887",
"login_id": "XXXXXXXXX",
"mail_address": "youremail@ntt.com",
"contract_owner": true,
"super_user": false,
"sss_endpoint": "https://sss-jp1-ecl.api.ntt.com:443/api",
"api_availability": true,
"keystone_endpoint": "https://keystone-jp1-ecl.api.ntt.com:443",
"keystone_name": "XXXXXXXXXXXXXXXXX",
"start_time": "2016-01-06 00:44:39",
"contract_id": "econ1000002353",
"login_integration": "icp",
"external_reference_id": "109876543210987",
"brand_id": "ecl2",
"otp_activation": true,
"otp_type": "totp",
"api_only": false,
"mfa_required": false,
"user_name": "XXXXXXXXXXX",
"user_comment": "XXXXXXXXXXX",
"bp_user_id": "bp-usr-123456789",
"bp_idf_user_id": "XXXXXXXXXXX",
"terms_agreement_flag": true,
"login_ip_address_restriction_flag": true
}

Update User

⚠️ This API is not allowed for contracts which was applied via NTT Communications business portal. In this case, if you need to update user's email, update user email on NTT Communications business portal, then SSO this service.

Overview

Update user information.

Classification

Update

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

user's id (ecidXXXXXXXXX)

Request Body schema: application/json

login_id	string [ 6 .. 60 ] characters New login id of the user.
mail_address	string <email> [ 1 .. 64 ] characters New email address of the user.
current_password	string <password> [ 8 .. 50 ] characters Current password of the user. You can specify this parameter only when you change your own user. This parameter is required when you specify new_password.
new_password	string <password> [ 8 .. 50 ] characters Password of the user. You can specify this parameter only when you change your own user. Single-byte alphanumeric characters, and !#$%&()*+,-./:;<=>?@[]^_`{\|}~ can be used. Must contain at least one uppercase letter, one lowercase letter, and one number. String length must be between 8 and 50 characters.
user_name	string [ 1 .. 512 ] characters New user_name of the user.
user_comment	string <= 512 characters New user_comment of the user.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated login conflicts existing user

put/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"mail_address": "test@ntt.com"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Delete User (For partner user only)

⚠️ This API is not allowed for contracts which was applied via NTT Communications business portal.

Overview

Delete user.
Delete users in the designated contract. This API can be used by Partner user only.

Classification

Delete

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

user's id (ecidXXXXXXXXX)

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated login conflicts existing user

delete/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

List Users information

Overview

List users in the designated contract.

Classification

List

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

contract_id

string

Contract ID ( Default is the Contract ID of API executing user. ).

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/users

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ1000002891",
"users": 
[
{"user_id": "ecid1000005697",
"login_id": "test1",
"mail_address": "test1@ntt.com",
"contract_owner": true,
"super_user": true,
"api_availability": true,
"start_time": "2016-01-0600:44:39",
"api_only": false,
"user_name": "XXXXXXXXXXX",
"user_comment": "XXXXXXXXXXX",
"bp_user_id": "bp-usr-123456789",
"bp_idf_user_id": "XXXXXXXXXXX",
"terms_agreement_flag": true,
"login_ip_address_restriction_flag": true
},
{"user_id": "ecid1000006346",
"login_id": "test2",
"mail_address": "test2@ntt.com",
"contract_owner": false,
"super_user": false,
"api_availability": true,
"start_time": "2016-01-1304:39:13",
"api_only": false,
"user_name": "XXXXXXXXXXX",
"user_comment": "XXXXXXXXXXX",
"bp_user_id": "bp-usr-123456789",
"bp_idf_user_id": "XXXXXXXXXXX",
"terms_agreement_flag": true,
"login_ip_address_restriction_flag": true
}
]
}

Create User (For partner user only)

⚠️ This API is not allowed for contracts which was applied via NTT Communications business portal. In this case, if you need to update user's email, update user email on NTT Communications business portal, then SSO this service.

Overview

Create users in the designated contract.
This API can be used by Partner user only.
Partner user can create users at enduser's contract only.

Classification

Create

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

login_id required	string [ 6 .. 60 ] characters Login id of new user. Single-byte alphanumeric characters, and @+-._ can be used. String length must be between 6 and 60 characters. The login_id must be unique system-wide, including deleted users. It is recommended to save this login ID, as it cannot be retrieved later via the API.
mail_address required	string <email> [ 8 .. 64 ] characters Mail address of new user. E-mail must be less than 60 characters
password	string <password> [ 8 .. 50 ] characters Password of the user. Single-byte alphanumeric characters, and !#$%&()*+,-./:;<=>?@[]^_`{\|}~ can be used. Must contain at least one uppercase letter, one lowercase letter, and one number. String length must be between 8 and 50 characters. If the API user set this item as blank, the system set initial random password automatically.
contract_id required	string Contract ID for user creation
notify_password required	boolean If this flag is set 'true', notification eamil will be sent to new user's email.
user_name	string [ 1 .. 512 ] characters name of the user. If not specified, user_name is the same as login_id.
user_comment	string <= 1024 characters description of the user.

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated login conflicts existing user

post/users

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"login_id": "test001",
"mail_address": "test@ntt.com",
"password": "Dsrtf34ht",
"contract_id": "econXXXXXXXXX",
"notify_password": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"login_id": "specifilogin",
"mail_address": "test@ntt.com",
"user_id": "ecid1000014777",
"contract_id": "econ1000002251",
"keystone_endpoint": "https://keystone-jp1-ecl.api.ntt.com:443",
"sss_endpoint": "https://sss-jp1-ecl.api.ntt.com:443/api",
"password": "PasswordYouDefine",
"user_name": "XXXXXXXXXXX",
"user_comment": "XXXXXXXXXXX"
}

Update API key pair

Overview

Update your own API key pair. You can't change API keys of other users. ※This API cannot be executed when the target user is API unavailable setting.

Classification

Update

API Operation Object

API Key

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target user iD (ecid)

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

put/keys/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/keys/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/keys/{user_id}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"user_id": "ecidXXXXX",
"keystone_name": "XTI3u6blgmW3Bje0jDjkBKlFG4GmI4kn",
"keystone_password": "Fcx1nZUprR8wg57k",
"status": "Success"
}

Update Auto Role Settings (For partner user only)

Overview

Update auto role setting for partner user.
This API can be used by Partner user only.
Users with on setting automatically have assignment to the tenant when viewing the tenant information of the child contract.

Classification

Update

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

The User who wants to set automatic role to child contract tenant

Request Body schema: application/json

auto_role_assignment_flag

required

boolean

Auto role assignment setting (true: on, false: off)

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

409

Designated login conflicts existing user

put/users/{user_id}/auto-role-assignment

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}/auto-role-assignment

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}/auto-role-assignment

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"auto_role_assignment_flag": true
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Enable OTP Authentication

Overview

Enable OTP Authentication of the target user. You can either choose TOTP or MailOTP as the OTP method.

Classification

Update

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID (ecid)

Request Body schema: application/json

otp_type required	string <totp/mail> OTP Authentication Method (totp/mail)
secret_key	string [ 1 .. 32 ] characters Secret key of the target user's one-time password. Required when otp_type is totp.
backup_code	Array of strings Array of backup codes for the target user's one-time password. Required when otp_type is totp.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

put/users/{user_id}/otp-authentication

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}/otp-authentication

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}/otp-authentication

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"otp_type": "totp",
"secret_key": "7CJ8EMTWCWCZ82BZ7CJ8EMTWCWCZ82BZ",
"backup_code": 
["13809596",
"38672052",
"37834269",
"96116052",
"87650081"
]
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Disable OTP Authentication

Overview

Disable OTP Authentication of the target user.

Classification

Delete

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID (ecid)

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

delete/users/{user_id}/otp-authentication

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}/otp-authentication

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}/otp-authentication

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

List User's Login Events information

Overview

List user's login events in the designated contract.

Classification

List

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

user's id (ecidXXXXXXXXX)

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/users/{user_id}/login-events

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}/login-events

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}/login-events

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecid1000005697",
"events": 
[
{"event_type": "logout",
"event_datetime": "yyyy-mm-ddhh:mm:ss",
"client_ip_address": "XXX.XXX.XXX.XXX"
},
{"event_type": "login_success",
"event_datetime": "yyyy-mm-ddhh:mm:ss",
"client_ip_address": "XXX.XXX.XXX.XXX"
}
]
}

Update API Availability

Overview

Update user's API available setting.

Classification

Update

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

user's id (ecidXXXXXXXXX)

Request Body schema: application/json

api_availability

required

boolean

API available or not.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated login conflicts existing user

put/users/{user_id}/api-availability

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}/api-availability

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}/api-availability

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"api_availability": true
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Create API-Only User

Overview

Create API-only user in the designated contract.

Classification

Create

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

mail_address required	string <email> <= 64 characters Mail address of new user. E-mail must be less than 60 characters
contract_id	string Contract ID for user creation. Only partner users can specify this field.
user_name	string [ 1 .. 512 ] characters name of the user. If not specified, user_name is the same as login_id.
user_comment	string <= 1024 characters description of the user.

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/users/api-only

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/api-only

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/api-only

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"mail_address": "test@ntt.com",
"contract_id": "econ0000000000"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"login_id": "XXXXXXXXXXX",
"mail_address": "test@ntt.com",
"user_id": "XXXXXXXXXXX",
"contract_id": "econ0000000000",
"keystone_endpoint": "XXXXXXXXXX",
"sss_endpoint": "XXXXXXXXXXX",
"user_name": "XXXXXXXXXXX",
"user_comment": "XXXXXXXXXXX"
}

Get Your Own User Information

Overview

Get Your Own User Information.

Classification

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Responses

200

Success

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

get/me

GL1 Endpoint

https://api.ntt.com/sss/api/v2/me

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/me

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecid0000000100",
"contract_id": "econ0000001000"
}

Send MailOTP Activation Mail

Overview

This API sends an authentication code via email to verify if the destination of the one-time password is correct when enabling one-time password authentication (MailOTP).

Classification

Create

API Operation Object

user

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID (ecid)

Request Body schema: application/json

Require empty body ({})

Responses

200

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/users/{user_id}/otp-authentication/mail

GL1 Endpoint

https://api.ntt.com/sss/api/v2/users/{user_id}/otp-authentication/mail

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/users/{user_id}/otp-authentication/mail

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{ }

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecidXXXXXXXXXX",
"hashed_verification_code": "00000000000000000000000000000000"
}

Tenant API

API for manage tenant(s).

Create Tenant

Overview

Create new tenant in the designated Workspace. Only super user (contract owner user) can use this API.

Classification

Create

API Operation Object

Tenant

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

workspace_id required	string Workspace which new tenant belongs to.
region required	string Region this tenant belongs to.

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/tenants

GL1 Endpoint

https://api.ntt.com/sss/api/v2/tenants

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/tenants

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"workspace_id": "ws0000000001",
"region": "jp-east"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"workspace_id": "ws0000000001",
"tenant_id": "462c8013d0e849e4b986ab2c181f2af8",
"tenant_name": "tenant_for_cheeseshop1",
"description": "cheeseshop_web",
"region": "jp1",
"contract_id": "econ1000002251"
}

List Tenants

Overview

Get list of tenant. Only tenants request user has access to will be listed.

Classification

List

API Operation Object

Tenant

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

contract_id

string

Contract ID (Default is the Contract ID of API executing user.).

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/tenants

GL1 Endpoint

https://api.ntt.com/sss/api/v2/tenants

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/tenants

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ1000002760",
"tenants": 
[
{"tenant_id": "b3bcbb8baeac41fc960e41a3a38dec09",
"tenant_name": "test0000002",
"description": "a",
"region": "jp1",
"start_time": "2016-02-16 10:50:59",
"workspace_id": "ws0000000002"
},
{"tenant_id": "724b1ebc748f46039783faf07af2885a",
"tenant_name": "TestTenant",
"description": "",
"region": "jp1",
"start_time": "2016-01-12 05:27:50",
"workspace_id": "ws0000000002"
},
{"tenant_id": "d8202d266ab64993b9ab909fb57ed0c8",
"tenant_name": "xxxxxxxxxx",
"description": "",
"region": "jp1",
"start_time": "2016-01-08 07:49:09",
"workspace_id": "ws0000000002"
}
]
}

Get Tenant

Overview

Get information about a tenant.

Classification

API Operation Object

Tenant

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

tenant_id

required

string

ID of the tenant

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/tenants/{tenant_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/tenants/{tenant_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/tenants/{tenant_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenant_id": "db695f004c214d0eb4117a7196ecddb7",
"tenant_name": "SampleTenant1",
"description": "",
"region": "jp1",
"contract_id": "econ1000002362",
"region_api_endpoint": "https://sss-jp1-ecl.api.ntt.com:443/api",
"start_time": "2016-02-12 01:27:53",
"users": 
[
{"user_id": "ecid1000003197",
"contract_owner": true,
"contract_id": "econ0123456789"
},
{"user_id": "ecid1000014662",
"contract_owner": false,
"contract_id": "econ0123456789"
},
{"user_id": "ecid1000014660",
"contract_owner": false,
"contract_id": "econ0123456789"
}
],
"brand_id": "ecl2",
"workspace_id": "ws0000000001"
}

Contract API

API for manage contract(s).

List Contracts(For partner user only)

Overview

List Contracts in the designated channel. This API can be used by Partner user only.

Classification

List

API Operation Object

Contracts

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

channel_id required	string Target channel_id under own contract
include_deleted	boolean Setting true or false(default is false) (true : Include deleted contract/ false: Not include deleted contract

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/contracts

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contracts": 
[
{"contract_id": "econXXXXXXXXXX",
"status": "enable",
"channel_id": "chxxxxx",
"channel_name": "test",
"contract_owner_user_id": "ecidxxxxxxxxxx",
"customer_number": "120000000123456",
"start_time": "9999-12-31 23:59:59",
"end_time": "9999-12-31 23:59:59",
"description": "Contract's description",
"parent_contract_id": ""
},
{"contract_id": "econXXXXXXXXXX",
"status": "enable",
"channel_id": "chxxxxx",
"channel_name": "test",
"contract_owner_user_id": "ecidxxxxxxxxxx",
"customer_number": "120000000123456",
"start_time": "9999-12-31 23:59:59",
"end_time": "9999-12-31 23:59:59",
"description": "Contract's description",
"parent_contract_id": "econXXXXXXXXXX"
},
{"contract_id": "econXXXXXXXXXX",
"status": "deleted",
"channel_id": "chxxxxx",
"channel_name": "test",
"contract_owner_user_id": "ecidxxxxxxxxxx",
"customer_number": "120000000123456",
"start_time": "9999-12-31 23:59:59",
"end_time": "9999-12-31 23:59:59",
"description": "Contract's description",
"parent_contract_id": "econXXXXXXXXXX"
}
]
}

Create Contract(For partner user only)

Overview

Create contract in designated channel. This API can be used by Partner user only.

Classification

Create

API Operation Object

Contracts

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

login_id required	string [ 6 .. 60 ] characters Login ID of new user. Single-byte alphanumeric characters, and @+-._ can be used. String length must be between 6 and 60 characters. The login_id must be unique system-wide, including deleted users. It is recommended to save this login ID, as it cannot be retrieved later via the API.
mail_address required	string <email> [ 1 .. 64 ] characters E-mail address of the user. E-mail must be less than 60 characters
password	string <password> [ 8 .. 50 ] characters Password of the user. Single-byte alphanumeric characters, and !#$%&()*+,-./:;<=>?@[]^_`{\|}~ can be used. Must contain at least one uppercase letter, one lowercase letter, and one number. String length must be between 8 and 50 characters. If the API user set this item as blank, the system set initial random password automatically.
external_reference_id	string [ 6 .. 50 ] characters By using this item, the partner API user can associate optional string to the constract(e.g. The end user management ID in the partner user's system). Single-byte alphanumeric characters can be used. String length must be between 6 and 50 characters. Note that this ID will be NOT used to control the contract in internal system. If the item is set as blank, ECL 2.0 system set the end user's contract ID automatically(e.g. econXXXXXXXX).
channel_id required	string The channel means the group to manage contracts. The partner user will be given 2 channels. One is the channel that contains own contract. The other is the channel that contains all end user contracts which the partner user has. By executing the List Channel API(For partner user only), the user can get your (and enduser's) channel ID.
notify_password	boolean Default: false Setting true or false(default is false). This item designate whether the system should send to the login_ID and Password with e-mail.
description	string <= 255 characters Description of the contract.
user_name	string [ 1 .. 512 ] characters name of new user. If not specified, user_name is the same as login_id.

Responses

202

Accepted

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/contracts

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"login_id": "example0001",
"mail_address": "example@example.com",
"password": "xxxxxxxx",
"channel_id": "ch0000000001",
"notify_password": false,
"description": "The contract's description"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Get Contract Information

Overview

Get the information of the designated contract.

Classification

API Operation Object

Contracts

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_id

required

string

Target contract ID (econ)

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/contracts/{contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts/{contract_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ1000088157",
"customer_number": "N0123456789",
"channel_name": "nttcom_partner1_retail",
"channel_id": "ch2000000022",
"management_channel": false,
"contract_owner_user_id": "ecid1000033406",
"status": "enable",
"login_integration": "",
"start_time": "2016-06-07 02:45:55",
"end_time": "",
"sss_endpoint": "https://sss-jp1-ecl.api.ntt.com:443/api",
"keystone_endpoint": "https://keystone-jp1-ecl.api.ntt.com:443",
"company_code": "",
"icp_portal_id": "",
"glass_customer_id": "",
"glass_user_id": "",
"brand_id": "ecl2",
"charge_reference_availability": true,
"description": "Contract's description",
"parent_contract_id": "econXXXXXXXXXX",
"bp_customer_id": "",
"login_ip_address_restriction_enabled": true
}

Delete Contract(For partner user only)

Overview

Delete contract in designated channel. This API can be used by Partner user only.

Classification

Delete

API Operation Object

Contracts

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_id

required

string

Target contract ID (econ)

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/contracts/{contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts/{contract_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Change Contract Information(For partner user only)

Overview

Change child contract's infomation of visble own billing information from child contract's super user. This API can be used by Partner user only.

Classification

Update

API Operation Object

Contracts

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

path Parameters

contract_id

required

string

Target contract ID (econ)

Request Body schema: application/json

charge_reference_availability	boolean visble own billing information from child contract's super user or not.
external_reference_id	string [ 6 .. 59 ] characters Change target customer number. Single-byte alphanumeric characters can be used. String length must be between 6 and 50 characters.
description	string <= 255 characters Description of the contract.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/contracts/{contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts/{contract_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"charge_reference_availability": true,
"external_reference_id": "string",
"description": "string"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Change Owner

Overview

Change contract's owner. Only super user(contract owner user) can use this API. Old super user(contract owner) become user

Classification

Update

API Operation Object

Contracts

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

path Parameters

contract_id

required

string

Target contract ID (econ)

Request Body schema: application/json

user_id

required

string

User ID

Responses

202

Accepted

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/contracts/{contract_id}/owner

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts/{contract_id}/owner

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts/{contract_id}/owner

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecid1000XXXXX"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Search Contracts (For partner user only)

Overview

Search contracts by several conditions. This API can be used by Partner user only.

Classification

API Operation Object

Contracts

Synchronous / Asynchronous

Synchronous

HTTP Request Path

Specify query parameters as below
- /api/v2/search/contracts?{search_key}={search_value}&{addtional_search_key}={addtional_search_value}

Authorizations:

X-Auth-Token

query Parameters

search_key	string You can select one of contract_id, customer_number, company_code, channel_id, channel_name, tenant_id, tenant_name, workspace_id, workspace_name, user_id.
search_value	string The value specified by the search key.
addtional_search_key	string You can set of start_time_from, start_time_to, end_time_from, end_time_to, include_deleted,max_rows. start_time_from/start_time_to/end_time_from/end_time_to parameters designates period of contract's start time or end time. include_deleted is status of contracts. max_rows is limit of searches. If you want to specify more than one, connect each parameter with &
addtional_search_value	string or number or boolean The value specified by the search key. start_time_from/start_time_to/end_time_from/end_time_to is in form of yyyymmddhhmmss. include_deleted is boolean. max_rows is 1-10000 number.

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

get/search/contracts

GL1 Endpoint

https://api.ntt.com/sss/api/v2/search/contracts

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/search/contracts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contracts": 
[
{"contract_id": "econXXXXXXXXXX",
"status": "enable",
"customer_number": "120000000123456",
"company_code": "C1234567890",
"start_time": "2017-04-01 00:00:00",
"end_time": "",
"description": "Contract's information",
"parent_contract_id": "econXXXXXXXXXX",
"login_integration": ""
},
{"contract_id": "econXXXXXXXXXX",
"status": "enable",
"customer_number": "120000000123456",
"company_code": "",
"start_time": "2017-04-01 00:00:00",
"end_time": "",
"description": "Contract's information",
"parent_contract_id": "",
"login_integration": ""
},
{"contract_id": "econXXXXXXXXXX",
"status": "deleted",
"customer_number": "120000000123456",
"company_code": "C1234567890",
"start_time": "2017-04-01 00:00:00",
"end_time": "2017-12-31 00:00:00",
"description": "",
"parent_contract_id": "econXXXXXXXXXX",
"login_integration": ""
}
]
}

Channel API

API for getting information abount channels.

List Channels (For Partner user Only)

Overview

Getting lists of information about the own channel and end user channel that own contract belongs. This API can be used by Partner user only.

About Channel

The channel means the group to manage contracts.
The partner user will be given 2 channels by Smart Data Platform system.
One is the channel that contains own contract. This channel is named partner management channel.
The other is the channel that contains all end user contracts which the partner user has.
By executing this API, the API user can get these 2 channel's information(including channel ID).

Classification

List

API Operation Object

Channels

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

get_contracts

boolean

Default: false

The flag of whether getting contracts(true or false(default)).

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/channels

GL1 Endpoint

https://api.ntt.com/sss/api/v2/channels

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/channels

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"channels": 
[
{"channel_id": "ch00002",
"channel_name": "chroot",
"language": "ja",
"management_channel": true,
"parent_channel_id": null,
"default_login_integration": null,
"contracts": 
[
{"contract_id": "econXXXXXXXXXX",
"status": "enable"
}
]
},
{"channel_id": "ch00003",
"channel_name": "ch01",
"language": "ja",
"management_channel": false,
"parent_channel_id": "ch00002",
"default_login_integration": null,
"contracts": 
[
{"contract_id": "econXXXXXXXXXX",
"status": "enable"
},
{"contract_id": "econXXXXXXXXXX",
"status": "deleted"
}
]
},
{"channel_id": "ch00004",
"channel_name": "ch02",
"language": "ja",
"management_channel": false,
"parent_channel_id": "ch00002",
"default_login_integration": "icp",
"contracts": 
[
{"contract_id": "econXXXXXXXXXX",
"status": "enable"
}
]
}
]
}

IAM API

API for IAM.

Create IAM Group

Overview

Create IAM Group in the designated contract. Only super user (contract owner user) can use this API.

Classification

Create

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

contract_id	string Contract ID( Default is the Contract ID of API executing user. ).
iam_group_name required	string [ 3 .. 60 ] characters New IAM Group name. Alphanumeric characters and @, -, ., _ can be used. String length must be between 3 and 60 characters.
description	string <= 255 characters Nullable Description of the IAM Group. String must be less than 255 characters

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/iam/groups

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econXXXXXXXX",
"iam_group_name": "string",
"description": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econXXXXXXXX",
"iam_group_id": "09d98eda-6421-11e6-9827-e1e34fb8c324",
"iam_group_name": "string",
"description": "string"
}

List IAM Group

Overview

Show IAM Group list in the designated contract.

Classification

List

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

contract_id

string

Contract ID( Default is the Contract ID of API executing user. ).

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/iam/groups

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econXXXXXXX",
"iam_groups": 
[
{"iam_group_name": "new_group1",
"iam_group_id": "XXXXXXXXXXXX",
"description": "new group 1",
"start_time": "2016-08-31 00:00:00",
"default_group": true,
"default_group_type": "all_allowed",
"iam_roles": 
[
{"iam_role_id": "XXXXXXXXXX",
"iam_role_name": "name"
}
]
},
{"iam_group_name": "new_group2",
"iam_group_id": "XXXXXXXXXXXX",
"description": "new group 2",
"start_time": "2016-08-31 00:00:00",
"default_group": false,
"default_group_type": "",
"iam_roles": 
[
{"iam_role_id": "XXXXXXXXXX",
"iam_role_name": "name1"
},
{"iam_role_id": "XXXXXXXXXX",
"iam_role_name": "name2"
}
]
}
]
}

List IAM Role

Overview

Show IAM Role list in the designated contract.

Classification

List

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

contract_id

string

Contract ID( Default is the Contract ID of API executing user. ).

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/iam/roles

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/roles

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/roles

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ1234567890",
"iam_roles": 
[
{"iam_role_name": "new_role1",
"iam_role_id": "e8422cea-6449-11e6-82d8-7f1d195e00b5",
"description": "new role 1"
},
{"iam_role_name": "new_role2",
"iam_role_id": "e8422cea-6449-11e6-82d8-7f1ssbeaga",
"description": "new role 2"
},
{"iam_role_name": "new_role3",
"iam_role_id": "e8422cea-6449-11e6-82d8-eagaewwaba",
"description": "new role 3"
}
]
}

Create IAM Role

Overview

Create IAM Role in the designated contract. Only super user (contract owner user) can use this API.

Classification

Create

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Operating Suggestions

"basePath" parameter in request body:
- This parameter define executable API's basepath in Smart Data Platform.
- Basepath means service classification of Smart Data Platform.
- You should set the parameter in accordance with the service you want to use.
- To see the basePath values, follow this link.

Authorizations:

X-Auth-Token

Request Body schema: application/json

contract_id	string Contract ID( Default is the Contract ID of API executing user. ).
iam_role_name required	string [ 3 .. 60 ] characters New IAM Role name. Alphanumeric characters and @, -, ., _ can be used. String length must be between 3 and 60 characters.
description	string <= 255 characters Nullable Description of the IAM Role. String must be less than 255 characters
resources required	Array of objects Whitelist rules of API execution.(A user can define any rule by using follow parameters. )

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/iam/roles

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/roles

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/roles

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econXXXXXXXXX",
"iam_role_name": "new_role",
"description": "new role",
"resources": 
[
{"ipAddress": "1.2.3.4/32",
"basePath": "/ecl-sss",
"path": "*",
"verb": "GET"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econXXXXXXXXX",
"iam_role_id": "e8422cea-6449-11e6-82d8-7f1d195e00b5",
"iam_role_name": "new_role",
"description": "new role",
"resources": 
[
{"ipAddress": "1.2.3.4/32",
"basePath": "/ecl-sss",
"path": "*",
"verb": "GET"
}
]
}

List User in the designated IAM Group

Overview

Show User list in the designated IAM Group ID.

Classification

List

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_group_id

required

string

IAM Group ID that you want to show user list.

Responses

200

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated login conflicts existing user

get/iam/groups/{iam_group_id}/users

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups/{iam_group_id}/users

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups/{iam_group_id}/users

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"iam_group_name": "new_group",
"iam_group_id": "xxxxx-xxxx-xxxx-xxxx-xxxx",
"description": "project A group",
"start_time": "2016-08-31 00:00:00",
"default_group": true,
"users": 
[
{"user_id": "ecidxxxxxxxxxxx"
},
{"user_id": "ecidyyyyyyyyyyy"
}
]
}

Get IAM Role Information

Overview

Show a IAM Role's information. You can check a IAM Role's name, ID and resources by executing this API.

Classification

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_role_id

required

string

Target IAM Role ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

get/iam/roles/{iam_role_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/roles/{iam_role_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/roles/{iam_role_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"iam_role_name": "new_role",
"iam_role_id": "xxxxx-xxxx-xxxx-xxxx-xxxx",
"description": "project A role",
"start_time": "2016-08-31 00:00:00",
"default_role": false,
"resources": 
[
{"basePath": "/ecl-sss",
"ipAddress": "*/*",
"path": "/users",
"verb": "GET"
},
{"basePath": "/ecl-nova",
"ipAddress": "*/*",
"path": "/*",
"verb": "GET"
}
]
}

Delete IAM Role

Overview

Delete designated IAM Role. Only super user (contract owner user) can use this API.

Classification

Delete

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_role_id

required

string

Target IAM Role ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/iam/roles/{iam_role_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/roles/{iam_role_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/roles/{iam_role_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Update IAM Role

Overview

Update IAM Role in the designated contract.

Classification

Update

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_role_id

required

string

Target IAM Role ID

Request Body schema: application/json

iam_role_name	string [ 3 .. 60 ] characters The IAM Role ID
description	string <= 255 characters Nullable Description of the IAM Role
resources	Array of objects Whitelist rules of API execution.(A user can define any rule by using follow parameters. )

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/roles/{iam_role_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/roles/{iam_role_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/roles/{iam_role_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"iam_role_name": "test_role",
"description": "test role",
"resources": 
[
{"ipAddress": "*",
"basePath": "*",
"path": "*",
"verb": "*"
}
]
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Assignment of IAM Role to IAM Group

Overview

Assignment of the IAM Role to the IAM Group.

Classification

Update

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_group_id required	string Target IAM Group ID
iam_role_id required	string Target IAM Role ID

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/groups/{iam_group_id}/roles/{iam_role_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups/{iam_group_id}/roles/{iam_role_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups/{iam_group_id}/roles/{iam_role_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"iam_group_id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"iam_group_name": "group_name",
"iam_role_id": "yyyyy-yyyy-yyyy-yyyy-yyyy",
"iam_role_name": "role_name"
}

Delete Assignment of IAM Role to IAM Group

Overview

Assignment of the IAM Role to the IAM Group.

Classification

Delete

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_group_id required	string Target IAM Group ID
iam_role_id required	string Target IAM Role ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/iam/groups/{iam_group_id}/roles/{iam_role_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups/{iam_group_id}/roles/{iam_role_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups/{iam_group_id}/roles/{iam_role_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Assignment of User to IAM Group

Overview

Assignment of the User to the IAM Group.

Classification

Update

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_group_id required	string Target IAM Group ID
user_id required	string Target User ID (ecid)

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

put/iam/groups/{iam_group_id}/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups/{iam_group_id}/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups/{iam_group_id}/users/{user_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"iam_group_id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"iam_group_name": "group_name",
"user_id": "ecidXXXXXXXXXX",
"api_availability": true
}

Delete Assignment of User to IAM Group

Overview

Delete Assignment of the User to the IAM Group.

Classification

Delete

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_group_id required	string Target IAM Group ID
user_id required	string Target User ID (ecid)

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/iam/groups/{iam_group_id}/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups/{iam_group_id}/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups/{iam_group_id}/users/{user_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Delete IAM Group

Overview

Delete designated IAM Group. Only super user (contract owner user) can use this API.

Classification

Delete

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_group_id

required

string

Target IAM Group ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/iam/groups/{iam_group_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups/{iam_group_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups/{iam_group_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Update IAM Group

Overview

Update IAM Group in the designated contract.

Classification

Update

API Operation Object

IAM ( API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

iam_group_id

required

string

Target IAM Group ID

Request Body schema: application/json

iam_group_name	string [ 3 .. 60 ] characters IAM Group name. Alphanumeric characters and @, -, ., _ can be used. String length must be between 3 and 60 characters.
description	string <= 255 characters Nullable Description of the IAM Group. String must be less than 255 characters

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/groups/{iam_group_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/groups/{iam_group_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/groups/{iam_group_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"iam_group_name": "string",
"description": "string"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Approval API

API for manage approval requests.

List Approval Requests

Overview

Get a list of approval requests.

Classification

List

API Operation Object

Approval

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

status	string Enum: "registered" "approved" "denied" "cancelled" "expired" "approval_expired" Setting status of approval request for searching.
service	string Setting status of service name for searching. (e.g. sss, network)
status_update_time_from	string Setting date and time of inactive approval requests whose status has changed after the specified date and time (including the specified date and time) for searching. (format: YYYYMMDDhhmmss, e.g. 20220101000000)
status_update_time_to	string Setting date and time of inactive approval requests whose status has changed before the specified date and time (including the specified date and time) for searching. (format: YYYYMMDDhhmmss, e.g. 20220101000000)
contract_id	string Contract ID (For partner user only).

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/approval-requests

GL1 Endpoint

https://api.ntt.com/sss/api/v2/approval-requests

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/approval-requests

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"approval_requests": 
[
{"request_id": "req000000XXXX",
"external_request_id": "test007",
"approver_type": "tenant_owner",
"approver_id": "11a98bf9cb144af5a204c9da566d2bd0",
"request_user_id": "ecid1000XXXXXX",
"service": "network",
"actions": 
[
{"service": "network",
"region": "jp1",
"api_path": "/network/v1/firewall",
"method": "POST",
"body": "request's body json"
}
],
"descriptions": 
[
{"lang": "en",
"text": "approval request test"
}
],
"request_user": false,
"approver": true,
"approval_deadline": "2017-02-05 09:45:22",
"approval_expire": null,
"registered_time": "2017-01-31 07:43:13",
"updated_time": null,
"status": "registered",
"status_updated_time": "2017-02-03 09:03:22"
},
{"request_id": "req0000000XXX",
"external_request_id": "test006",
"approver_type": "tenant_owner",
"approver_id": "66a98bf9cb1238192a204c9da566dbd0",
"request_user_id": "ecid1000XXXXXX",
"service": "network",
"actions": 
[
{"service": "network",
"region": "jp1",
"api_path": "/network/v1/firewall",
"method": "POST",
"body": "request's body json"
}
],
"descriptions": 
[
{"lang": "en",
"text": "approval request test"
}
],
"request_user": false,
"approver": true,
"approval_deadline": "2016-12-25 09:45:22",
"approval_expire": null,
"registered_time": "2016-12-13 02:20:21",
"updated_time": null,
"status": "expired",
"status_updated_time": "2017-02-03 09:03:22"
}
]
}

Get Approval Request

Overview

Get information of approval request.

Classification

API Operation Object

Approval

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

request_id

required

string

Target Request ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/approval-requests/{request_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/approval-requests/{request_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/approval-requests/{request_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"request_id": "req000000XXXX",
"external_request_id": "test007",
"approver_type": "tenant_owner",
"approver_id": "11a98bf9cb144af5a204c9da566d2bd0",
"request_user_id": "ecid1000XXXXXX",
"service": "network",
"actions": 
[
{"service": "network",
"region": "jp1",
"api_path": "/network/v1/firewall",
"method": "POST",
"body": "request's body json"
}
],
"descriptions": 
[
{"lang": "en",
"text": "approval request test"
}
],
"request_user": true,
"approver": true,
"approval_deadline": "2017-02-05 09:45:22",
"approval_expire": null,
"registered_time": "2017-01-31 07:43:13",
"updated_time": null,
"status": "registered",
"status_updated_time": "2017-02-03 09:03:22"
}

Update Approval Request

Overview

Update status of approval request.

Classification

Update

API Operation Object

Approval

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

request_id

required

string

Target Request ID

Request Body schema: application/json

status

string

Enum: "approved" "cancelled" "denied"

Modify status of the approval request. Request's status can only change from 'registered'

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/approval-requests/{request_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/approval-requests/{request_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/approval-requests/{request_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"status": "approved"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Create Workspace Migration Request

Overview

Create approval request for workspace migration.
Migration of the same workspace can be carried out only once per month. If the workspace has already been migrated within the month, the request will be rejected.
Only super user (contract owner user) and partner user can use this API.

Classification

Create

API Operation Object

Approval

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

workspace_id required	string Target workspace ID
contract_id required	string ID of the new contract to which the workspace will belong

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/approval-requests/workspace-migration

GL1 Endpoint

https://api.ntt.com/sss/api/v2/approval-requests/workspace-migration

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/approval-requests/workspace-migration

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"workspace_id": "wsXXXXXXXXXX",
"contract_id": "econXXXXXXXXXX"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"request_id": "abcdef1234567",
"external_request_id": null,
"approver_type": "contract_owner",
"approver_id": "econXXXXXXXXXX",
"request_user_id": "ecidXXXXXXXXXX",
"service": "sss",
"actions": 
[
{"workspace_id": "wsXXXXXXXXXX",
"origin_contract_id": "econXXXXXXXXXX",
"destination_contract_id": "econYYYYYYYYYY"
}
],
"descriptions": 
[
{"lang": "en",
"text": "User ecidXXXXXXXXX is requesting workspace workspace_idxxxxxxxxxxx migration to contract econxxxxxxxxxx. Workspace name is xxxxxxxx. Description is xxxxxx."
}
],
"request_user": true,
"approver": false,
"approval_deadline": "2016-12-30 00:45:22",
"registered_time": "2016-11-30 23:25:47",
"status": "registered"
}

Cancel Workspace Migration Request

Overview

Cancel workspace migration request.
Cancellations can only be performed on approval requests with a status of 'approved' and within the validity period.

Classification

Delete

API Operation Object

Approval

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id

required

string

Target Workspace ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/approval-requests/workspace-migration/{workspace_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/approval-requests/workspace-migration/{workspace_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/approval-requests/workspace-migration/{workspace_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Billing API

API for getting billing information.

Get Billing Summary information

Overview

Get billing summary statement of designated month.
Depending on your settings, API may not be able to execute.

Classification

API Operation Object

Billing

Synchronous / Asynchronous

Synchronous

Additional Info

The format of the data to be returned changes depending on the parameter format. If the format is specified as csv, the data returned will be in text/csv and the response will be as follows.

"classification","contract_id","customer_number","item_id","name","description","amount","currency","billing_month","billing_status"
"total","econXXXXXX","1200000000000XX","","","","11000","JPY","2021-02","estimated"
"item","econXXXXXX","1200000000000XX","workspace","ワークスペース","ワークスペースA","5000","JPY","2021-02","estimated"
"item","econXXXXXX","1200000000000XX","workspace","ワークスペース","ワークスペースB","3000","JPY","2021-02","estimated"
"item","econXXXXXX","1200000000000XX","contract","子契約","子契約α","1000","JPY","2021-02","estimated"
"item","econXXXXXX","1200000000000XX","tax","税金","","1000","JPY","2021-02","estimated"

Authorizations:

X-Auth-Token

path Parameters

contract_id required	string Billing statement owner contract. (econXXXXXXXXXXX)
target_month required	string Target billing month with YYYY-MM format

query Parameters

format

string

Default: "json"

Enum: "json" "csv"

Response's format. (json/csv) (In case of not specified, default response format is json)

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/contracts/{contract_id}/billing/{target_month}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts/{contract_id}/billing/{target_month}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts/{contract_id}/billing/{target_month}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"contract_id": "econ1000003351",
"customer_number": "120000000123456",
"charge_status": "estimated",
"cycle_start_time": "2021-11-0100:00:00",
"cycle_end_time": "2021-11-3023:59:59",
"charge_data": 
{"total_amount": "15000",
"currency": "JPY",
"item": 
[
{"item_id": "workspace",
"name": "ワークスペース",
"description": "ワークスペース説明",
"amount": "5000"
},
{"item_id": "contract",
"name": "子契約",
"description": "子契約説明",
"amount": "5000"
}
]
}
}

Get Monthly Billing Summary of each contract (For partner user only)

Overview

Get montly billing summary for each contract. This API can be used by Partner user only.
Depending on your settings, API may not be able to execute.

Classification

API Operation Object

Billing

Synchronous / Asynchronous

Synchronous

Additional Info

The format of the data to be returned changes depending on the parameter format. If the format is specified as csv, the data returned will be in text/csv and the response will be as follows.

"classification","contract_id","customer_number","item_id","name","description","amount","currency","billing_month","billing_status"
"total","econXXXXXX","1200000000000XX","","","","11000","JPY","2021-02","estimated"
"item","econXXXXXX","1200000000000XX","workspace","ワークスペース","ワークスペースA","5000","JPY","2021-02","estimated"
"item","econXXXXXX","1200000000000XX","workspace","ワークスペース","ワークスペースB","3000","JPY","2021-02","estimated"
"item","econXXXXXX","1200000000000XX","tax","税金","","1000","JPY","2021-02","estimated"

Authorizations:

X-Auth-Token

path Parameters

contract_id required	string The contract ID that the user who should pay the usage fee has (Typically Partner's contract ID or end user contract ID).
target_month required	string The month(YYYY-MM) of getting billing information
target_contract_id required	string The contract ID that the API user want to get the detail of billing information. The API user can get the contract's usage fee designated by this item(target_contract_id) that belongs 'contract_id'

query Parameters

format

string

Default: "json"

Enum: "json" "csv"

Response's format. (json/csv) (In case of not specified, default response format is json)

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/contracts/{contract_id}/billing/{target_month}/target_contract/{target_contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts/{contract_id}/billing/{target_month}/target_contract/{target_contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts/{contract_id}/billing/{target_month}/target_contract/{target_contract_id}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"contract_id": "econ1000003351",
"customer_number": "120000000123456",
"charge_status": "estimated",
"cycle_start_time": "2021-11-0100:00:00",
"cycle_end_time": "2021-11-3023:59:59",
"charge_data": 
{"total_amount": "15000",
"currency": "JPY",
"item": 
[
{"item_id": "workspace",
"name": "ワークスペース",
"description": "ワークスペース説明",
"amount": "5000"
},
{"item_id": "contract",
"name": "子契約",
"description": "子契約説明",
"amount": "5000"
}
]
}
}

Create Billing Summary Bulk File (For partner user only)

Overview

Create billing summary bulk file in designated channel. This API can be used by Partner user only.When creating a new file, old files are deleted.

Classification

Create

API Operation Object

Billing

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

channel_id	string Enduser's channel ID
number_of_months	integer Number of months to acquire the billing information.If not specified, the system set the most recent one month automatically.This parameter must be less than or equal to 24

Responses

202

Accepted

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/billing-bulk-files

GL1 Endpoint

https://api.ntt.com/sss/api/v2/billing-bulk-files

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/billing-bulk-files

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"channel_id": "ch00001",
"number_of_months": 24
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Get Billing Bulk File (For partner user only)

Overview

Get billing bulk file of the designated contract.

Classification

API Operation Object

Billing

Synchronous / Asynchronous

Synchronous

Additional Info

This API returns ZIP file in application/octet-stream format. Please save this as your own file.
Example:
- curl -i -1 -H "Accept:application/json" -H "X-Auth-Token:a8a80f76af354036bdf9358d6a5865cd" -o your_own.zip https://sss-jp1-ecl.api.ntt.com/api/v2/billing-bulk-files/87434aa7-12c3-4f41-aa0c-43e832028628

Authorizations:

X-Auth-Token

path Parameters

file_id

required

string

The bulk file id.This file id can be obtained from Transaction API's response. Transaction ID is paid out from Create Billing Bulk File API

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Conflict of the Request

get/billing-bulk-files/{file_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/billing-bulk-files/{file_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/billing-bulk-files/{file_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Create Billing Summary Bulk File For WholeSale (For partner user only)

Overview

Create billing summary bulk file for wholesale fee. This API can be used by Partner user only.When creating a new file, old files are deleted. This API can get the bill you are charged and the bill for child contract included in charge you are charged.

Classification

Create

API Operation Object

Billing

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

number_of_months

integer

Number of months to acquire the billing information.If not specified, the system set the most recent one month automatically.This parameter must be less than or equal to 24

Responses

202

Accepted

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/billing-bulk-files/wholesale

GL1 Endpoint

https://api.ntt.com/sss/api/v2/billing-bulk-files/wholesale

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/billing-bulk-files/wholesale

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"number_of_months": 24
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": 400,
"title": "Bad Request",
"message": "createBillingBulkFilesForWholesale.arg1.numberOfMonths : must be less than or equal to 24, "
}

Get Billing Detail information

Overview

Get billing detail statement of designated month.
Depending on your settings, API may not be able to execute.

Classification

API Operation Object

Billing

Synchronous / Asynchronous

Synchronous

Additional Info

The format of the data to be returned changes depending on the parameter format. If the format is specified as csv, the data returned will be in text/csv and the response will be as follows.

"classification","contract_id","customer_number","workspace_id","workspace_name","tenant_id","item_id","category","sub_category","menu","menu_detail","plan","geographic_id","description","charge_object_id","usage_value","usage_unit","amount","currency","tax","billing_month","billing_status"
"Monthly fee","econXXXXXXXXXX","econXXXXXXXXXX","wsXXXXXX","TEST1","xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","server-instance.compute.1cpu-4gb.running","Cloud/Server","Virtual Server","Server Instance","Compute","1CPU-4GB Running","JP1","","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","6207","Min","1077.61","JPY","合算","2021-02","fixed"
"Tax","econXXXXXXXXXX","econXXXXXXXXXX","","","","","","","","","","","税区分：合算 消費税率：10%","","","","11532","JPY","合算","2021-02","fixed"

Authorizations:

X-Auth-Token

path Parameters

contract_id required	string Billing statement owner contract. (econXXXXXXXXXXX)
target_month required	string Target billing month with YYYY-MM format

query Parameters

format	string Default: "json" Enum: "json" "csv" Response's format. (json/csv) (In case of not specified, default response format is json)
limit	string The limit for the displaying rows. (default: 50, min: 1, max: 1000)
offset	string The offset for the displaying rows. (default:0, min: 0)

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/contracts/{contract_id}/billing/{target_month}/detail

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts/{contract_id}/billing/{target_month}/detail

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts/{contract_id}/billing/{target_month}/detail

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"contract_id": "econ0123456789",
"customer_number": "120000000123456",
"charge_status": "fixed",
"cycle_start_time": "2021-04-01 00:00:00",
"cycle_end_time": "2021-04-30 23:59:59",
"charge_data_total": 1000,
"charge_data_start_at": 1,
"charge_data_page_size": 100,
"charge_data": 
[
{"classification": "Monthly fee",
"contract_id": "econ0123456789",
"customer_number": "econ0123456789",
"workspace_id": "wsXXXXXX",
"workspace_name": "TEST1",
"tenant_id": "f163821fafcf42b18dcef41b354c457c",
"item_id": "server-instance.compute.1cpu-4gb.running",
"category": "Cloud/Server",
"sub_category": "Virtual Server",
"menu": "Server Instance",
"menu_detail": "Compute",
"plan": "1CPU-4GB Running",
"geographic_id": "JP1",
"description": "",
"charge_object_id": "99519e48-2240-450f-96b9-4556961f6d5e",
"usage_value": "6207",
"usage_unit": "Min",
"amount": "1077.61",
"currency": "JPY",
"tax": "合算"
},
{"classification": "Tax",
"contract_id": "econ0123456789",
"customer_number": "econ0123456789",
"workspace_id": "",
"workspace_name": "",
"tenant_id": "",
"item_id": "",
"category": "",
"sub_category": "",
"menu": "",
"menu_detail": "",
"plan": "",
"geographic_id": "",
"description": "税区分：合算 消費税率：10%",
"charge_object_id": "",
"usage_value": "",
"usage_unit": "",
"amount": "11532",
"currency": "JPY",
"tax": "合算"
}
]
}

Get Monthly Billing Detail of each contract(For partner user only)

Overview

Get billing detail statement of designated month.
Depending on your settings, API may not be able to execute.

Classification

API Operation Object

Billing

Synchronous / Asynchronous

Synchronous

Additional Info

The format of the data to be returned changes depending on the parameter format. If the format is specified as csv, the data returned will be in text/csv and the response will be as follows.

"classification","contract_id","customer_number","workspace_id","workspace_name","tenant_id","item_id","category","sub_category","menu","menu_detail","plan","geographic_id","description","charge_object_id","usage_value","usage_unit","amount","currency","tax","billing_month","billing_status"
"Monthly fee","econXXXXXXXXXX","econXXXXXXXXXX","wsXXXXXX","TEST1","xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","server-instance.compute.1cpu-4gb.running","Cloud/Server","Virtual Server","Server Instance","Compute","1CPU-4GB Running","JP1","","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","6207","Min","1077.61","JPY","合算","2021-02","fixed"
"Tax","econXXXXXXXXXX","econXXXXXXXXXX","","","","","","","","","","","税区分：合算 消費税率：10%","","","","11532","JPY","合算","2021-02","fixed"

Authorizations:

X-Auth-Token

path Parameters

contract_id required	string The contract ID that the user who should pay the usage fee has (Typically Partner's contract ID or end user contract ID).
target_month required	string The month(YYYY-MM) of getting billing information
target_contract_id required	string The contract ID that the API user want to get the detail of billing information. The API user can get the contract's usage fee designated by this item(target_contract_id) that belongs 'contract_id'

query Parameters

format	string Default: "json" Enum: "json" "csv" Response's format. (json/csv) (In case of not specified, default response format is json)
limit	string The limit for the displaying rows. (default: 50, min: 1, max: 1000)
offset	string The offset for the displaying rows. (default:0, min: 0)

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/contracts/{contract_id}/billing/{target_month}/target_contract/{target_contract_id}/detail

GL1 Endpoint

https://api.ntt.com/sss/api/v2/contracts/{contract_id}/billing/{target_month}/target_contract/{target_contract_id}/detail

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/contracts/{contract_id}/billing/{target_month}/target_contract/{target_contract_id}/detail

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"contract_id": "econ0123456789",
"customer_number": "120000000123456",
"charge_status": "fixed",
"cycle_start_time": "2021-04-01 00:00:00",
"cycle_end_time": "2021-04-30 23:59:59",
"charge_data_total": 1000,
"charge_data_start_at": 1,
"charge_data_page_size": 100,
"charge_data": 
[
{"classification": "Monthly fee",
"contract_id": "econ0123456789",
"customer_number": "econ0123456789",
"workspace_id": "wsXXXXXX",
"workspace_name": "TEST1",
"tenant_id": "f163821fafcf42b18dcef41b354c457c",
"item_id": "server-instance.compute.1cpu-4gb.running",
"category": "Cloud/Server",
"sub_category": "Virtual Server",
"menu": "Server Instance",
"menu_detail": "Compute",
"plan": "1CPU-4GB Running",
"geographic_id": "JP1",
"description": "",
"charge_object_id": "99519e48-2240-450f-96b9-4556961f6d5e",
"usage_value": "6207",
"usage_unit": "Min",
"amount": "1077.61",
"currency": "JPY",
"tax": "合算"
},
{"classification": "Tax",
"contract_id": "econ0123456789",
"customer_number": "econ0123456789",
"workspace_id": "",
"workspace_name": "",
"tenant_id": "",
"item_id": "",
"category": "",
"sub_category": "",
"menu": "",
"menu_detail": "",
"plan": "",
"geographic_id": "",
"description": "税区分：合算 消費税率：10%",
"charge_object_id": "",
"usage_value": "",
"usage_unit": "",
"amount": "11532",
"currency": "JPY",
"tax": "合算"
}
]
}

Create Billing Detail Bulk File (For partner user only)

Overview

Create billing detail bulk file in designated channel. This API can be used by Partner user only.When creating a new file, old files are deleted.

Classification

Create

API Operation Object

Billing

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

channel_id	string Enduser's channel ID
number_of_months	integer Number of months to acquire the billing information.If not specified, the system set the most recent one month automatically.This parameter must be less than or equal to 24

Responses

202

Accepted

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/billing-bulk-files/detail

GL1 Endpoint

https://api.ntt.com/sss/api/v2/billing-bulk-files/detail

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/billing-bulk-files/detail

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"channel_id": "ch00001",
"number_of_months": 24
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Create Billing Detail Bulk File For WholeSale (For partner user only)

Overview

Create billing detail bulk file for wholesale fee. This API can be used by Partner user only.When creating a new file, old files are deleted. This API can get the bill you are charged and the bill for child contract included in charge you are charged.

Classification

Create

API Operation Object

Billing

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

channel_id	string Enduser's channel ID
number_of_months	integer Number of months to acquire the billing information.If not specified, the system set the most recent one month automatically.This parameter must be less than or equal to 24

Responses

202

Accepted

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/billing-bulk-files/wholesale/detail

GL1 Endpoint

https://api.ntt.com/sss/api/v2/billing-bulk-files/wholesale/detail

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/billing-bulk-files/wholesale/detail

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"channel_id": "ch00001",
"number_of_months": 24
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Transaction API

API for Transaction.

Get Result of Transaction

Overview

Get the result of the transaction.

Classification

API Operation Object

Transaction

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

transaction_id

required

string

The transaction ID getting result

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/transactions/{transaction_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/transactions/{transaction_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/transactions/{transaction_id}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"status": "inprogress"
}

Contract Group API

API for managing Contract Groups.

Create Contract Group (For partner user only)

Overview

Create a new contract group under designated Contract Group.

Classification

Create

API Operation Object

Contract Group

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

parent_contract_group_id required	string Parent contract group ID of this contract group
contract_group_name required	string Name for this contract group. 1-255 alphanumerical and @-._ characters are allowed.
description	string Descriptions for this contract group. String must be less than 255 characters

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/iam/contract-groups

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/contract-groups

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/contract-groups

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"parent_contract_group_id": "ecgrXXXXXXXX",
"contract_group_name": "new_group",
"description": "new group"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econXXXXXXXX",
"parent_contract_group_id": "ecgrXXXXXXXX",
"contract_group_id": "ecgrXXXXXXXX",
"contract_group_name": "string",
"description": "string"
}

List Contract Group (For partner user only)

Overview

Show a list of contract groups.

Classification

List

API Operation Object

Contract Group

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

contract_id

required

string

Target contract of this API

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

get/iam/contract-groups

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/contract-groups

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/contract-groups

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econXXXX",
"contract_group": 
{"contract_group_id": "ecgrXXXX",
"contract_group_name": "XXXX",
"description": "XXXX",
"contract_groups": 
[
{"contract_group_id": "ecgrXXXX",
"contract_group_name": "XXXX",
"description": "XXXX",
"contract_groups": [ ]
}
]
}
}

Update Contract Group (For partner user only)

Overview

Modify existing contract group's name and / or descriptions.

Classification

Update

API Operation Object

Contract Group

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_group_id

required

string

Target Contract Group ID

Request Body schema: application/json

contract_group_name	string New name for this contract group. 1-255 alphanumerical and @-._ characters are allowed.
description	string New descriptions for this contract group. String must be less than 255 characters

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/contract-groups/{contract_group_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/contract-groups/{contract_group_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/contract-groups/{contract_group_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"contract_group_name": "update_group",
"description": "update group"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Delete Contract Group (For partner user only)

Overview

Delete contract group.

Classification

Delete

API Operation Object

Contract Group

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_group_id

required

string

Target Contract Group ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/iam/contract-groups/{contract_group_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/contract-groups/{contract_group_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/contract-groups/{contract_group_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Get Contract Group (For partner user only)

Overview

Get the details of target contract group.

Classification

API Operation Object

Contract Group

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_group_id

required

string

Target Contract Group ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

get/iam/contract-groups/{contract_group_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/contract-groups/{contract_group_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/contract-groups/{contract_group_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_group_id": "ecgrXXXX",
"contract_group_name": "XXXX",
"description": "XXXX",
"start_time": "2000-01-01 00:00:00",
"contracts": 
[
{"contract_id": "econXXXX",
"status": "deleted",
"customer_number": "XXXXXXXX",
"start_time": "2000-01-01 00:00:00",
"end_time": "2001-12-31 23:59:59",
"channel_id": "chXXXX",
"channel_name": "XXXXXXXX"
}
],
"users": 
[
{"user_id": "ecidXXXX01",
"contract_owner": true
}
]
}

Assign Contract to Contract Group (For partner user only)

Overview

Assign a contract access authority to contract group. Users in the contract group can access to contracts assigned to the group they are in.

Classification

Modify

API Operation Object

Contract Group
Contract

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_group_id required	string Target Contract Group ID
contract_id required	string Target Contract ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/contract-groups/{contract_group_id}/contracts/{contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/contract-groups/{contract_group_id}/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/contract-groups/{contract_group_id}/contracts/{contract_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Delete Contract from Contract Group (For partner user only)

Overview

Delete a contract access authority from contract group. Users in the contract group cannot access to the contract once contract is deleted from groups they belong to.

Classification

Delete

API Operation Object

Contract Group

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_group_id required	string Target Contract Group ID
contract_id required	string Target Contract ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/iam/contract-groups/{contract_group_id}/contracts/{contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/contract-groups/{contract_group_id}/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/contract-groups/{contract_group_id}/contracts/{contract_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Put User to Contract Group (For partner user only)

Overview

Put a user into a contract group. User and contract group need to be in the same contract, and contract owner must be in the root contract group(cannot move).

Classification

Update

API Operation Object

Contract Group
User

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_group_id required	string Target Contract Group ID
user_id required	string User's ID put into this contract group

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/contract-groups/{contract_group_id}/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/contract-groups/{contract_group_id}/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/contract-groups/{contract_group_id}/users/{user_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

User Type API

API for User Type Management

List User Type

Overview

Show User Type List in the designated contract.

Classification

List

API Operation Object

IAM ( User Type Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

contract_id

required

string

Contract ID that you want to get User Type List.

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/iam/user-types/users

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/user-types/users

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/user-types/users

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"users": 
[
{"user_id": "ecidXXXX",
"contract_owner": true,
"super_user": true
},
{"user_id": "ecidXXXX",
"contract_owner": false,
"super_user": true
},
{"user_id": "ecidXXXX",
"contract_owner": false,
"super_user": true,
"grant": 
["user",
"workspace"
]
},
{"user_id": "ecidXXXX",
"contract_owner": false,
"super_user": false
}
]
}

Get User Type Information

Overview

Show User Type Detail Information of the designated user.

Classification

API Operation Object

IAM ( User Type Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/iam/user-types/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/user-types/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/user-types/users/{user_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecidXXXX",
"contract_owner": false,
"super_user": true,
"grant": 
["user",
"workspace"
]
}

Update User Type

Overview

Update the designated user's User Type.

Classification

Update

API Operation Object

IAM ( User Type Management )

Synchronous / Asynchronous

Synchronous

Additional Info

You can set following portal control items as elements in grant array

item	description
user	User Management
workspace	Workspace Management
billing	Usage Fee Information Management
iam_api	API Permission Management
iam_user_type	User Type Management
iam_contract_group	Contract Group Management ( partner user only )

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID

Request Body schema: application/json

super_user required	boolean The Flag that indicate whether Super User or not
grant	Array of strings Items Enum: "user" "workspace" "iam_contract_group" "billing" "iam_api" "iam_user_type" "iam_menu" Portal control items which the user will be granted.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/user-types/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/user-types/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/user-types/users/{user_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"super_user": true,
"grant": 
["user",
"workspace"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": 400,
"title": "Bad Request",
"message": "Parameter : Grant does not contain required operation auth ID. Insufficient operation auth ID list for workspace operation: [user]",
"error_code": "RequiredOperationAuthInsufficient:workspace:user"
}

List Available Menus

Overview

Show available menu list in the designated user.

Classification

List

API Operation Object

IAM (API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/iam/menus/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/menus/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/menus/users/{user_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecidXXXXXXXXXX",
"menus": 
[
{"menu_name": "sss.menu.server_instance",
"available": true,
"display_name_ja": "サーバーインスタンス",
"display_name_en": "Server Instance",
"display_description_ja": "サーバーインスタンスの説明",
"display_description_en": "Server Instance Description"
}
]
}

Update Available Menus

Overview

Update availability of each menu in the designated user.

Classification

Update

API Operation Object

IAM (API Permission Management )

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID

Request Body schema: application/json

menus

Array of objects

Menu for setting availability of target user.(Specify one or more configurable menus)

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/menus/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/menus/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/menus/users/{user_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"menus": 
[
{"operation-portal": false
},
{"business-intelligence-portal": false
},
{"mss-secuity": true
},
{"operation-portal.mail.failure-notice": true
}
]
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

List Bookmarked Menus

Overview

Show bookmarked menu list in the designated workspace.

Classification

List

API Operation Object

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id required	string Target Workspace ID
user_id required	string Target User ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/menu-bookmarks/workspaces/{workspace_id}/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/menu-bookmarks/workspaces/{workspace_id}/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/menu-bookmarks/workspaces/{workspace_id}/users/{user_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"workspace_id": "ws0000000000",
"user_id": "ecid0000000000",
"menu_bookmarks": 
[
{"menu_name": "menu.a"
},
{"menu_name": "menu.b"
}
]
}

Update Bookmarked Menus

Overview

Update bookmarked menu list in the designated workspace.

Classification

Update

API Operation Object

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id required	string Target Workspace ID
user_id required	string Target User ID

Request Body schema: application/json

menu_bookmarks

Array of strings

List of menus to be bookmarked

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

put/menu-bookmarks/workspaces/{workspace_id}/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/menu-bookmarks/workspaces/{workspace_id}/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/menu-bookmarks/workspaces/{workspace_id}/users/{user_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"menu_bookmarks": 
["menu.a",
"menu.b",
"menu.c"
]
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

List Available Menus for Channel (For partner user only)

Overview

List available menus for specific channel. Only partner user can use this API.

Classification

List

API Operation Object

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

channel_id

required

string

Target Channel ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

get/iam/menus/channels/{channel_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/menus/channels/{channel_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/menus/channels/{channel_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"channel_id": "chXXXXXXXXXX",
"menus": 
[
{"menu_name": "sss.menu.server_instance",
"available": true,
"display_name_ja": "サーバーインスタンス",
"display_name_en": "Server Instance",
"display_description_ja": "サーバーインスタンスの説明",
"display_description_en": "Server Instance Description"
}
]
}

Update Available Menus for Channel (For partner user only)

Overview

Update available menus for specific channel. Only partner user can use this API.

Classification

Update

API Operation Object

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

channel_id

required

string

Target Channel ID

Request Body schema: application/json

menus

Array of objects

An array of objects, which have menu name and it's availability for the channel.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/iam/menus/channels/{channel_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/iam/menus/channels/{channel_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/iam/menus/channels/{channel_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"menus": 
[
{"menu_name": "operation-portal",
"available": false
},
{"menu_name": "mss-secuity",
"available": true
}
]
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Get Channel Setting for Menus (For partner user only)

Overview

Get menu-related setting for specific channel. Only partner user can use this API.
- If auto_enable_new_menu is true, newly added menus in Smart Data Platform will automatically be available for the channel.

Classification

API Operation Object

Channel

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

channel_id

required

string

Target Channel ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

get/channels/{channel_id}/settings

GL1 Endpoint

https://api.ntt.com/sss/api/v2/channels/{channel_id}/settings

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/channels/{channel_id}/settings

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"channel_id": "chXXXXX",
"auto_enable_new_menu": true
}

Update Channel Setting for Menus (For partner user only)

Overview

Update menu-related setting for specific channel. Only partner user can use this API.
If you set auto_enable_new_menu true, newly added menus in Smart Data Platform will automatically be available for the channel.

Classification

API Operation Object

Channel

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

channel_id

required

string

Target Channel ID

Request Body schema: application/json

auto_enable_new_menu

boolean

If true, newly added menus will be automatically available.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/channels/{channel_id}/settings

GL1 Endpoint

https://api.ntt.com/sss/api/v2/channels/{channel_id}/settings

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/channels/{channel_id}/settings

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"auto_enable_new_menu": true
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Notification API

API for managing notification settings.

List Notification of User

Overview

List notification settings in the designated user.

Classification

List

API Operation Object

Notification

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/notifications/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/notifications/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/notifications/users/{user_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecid999999",
"notification_types": 
[
{"notification_type": "trouble",
"editable": true,
"status": true,
"workspaces": 
[
{"workspace_id": "ws9999999991",
"workspace_name": "workspaceA",
"contract_id": "econ9999999001",
"status": true
},
{"workspace_id": "ws9999999992",
"workspace_name": "workspaceB",
"contract_id": "econ9999999002",
"status": false
}
]
},
{"notification_type": "sales",
"editable": true,
"status": false
}
]
}

Change Notification Settings of User

Overview

Change notification settings in the designated user.

Classification

Update

API Operation Object

Notification

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Target User ID

Request Body schema: application/json

notification_types

required

Array of objects

Array of notification settings

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

put/notifications/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/notifications/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/notifications/users/{user_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"notification_types": 
[
{"notification_type": "maintenance",
"status": true,
"workspaces": 
[
{"workspace_id": "ws9999999991",
"status": true
},
{"workspace_id": "ws9999999992",
"status": false
}
]
},
{"notification_type": "sales",
"status": false
}
]
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

List Notifications of Contracts (For partner user only)

Overview

Notification settings of the designated contract.This API can be used by Partner user only.

Classification

List

API Operation Object

Notification

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_id

required

string

Target Contract ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/notifications/contracts/{contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/notifications/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/notifications/contracts/{contract_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ9999999999",
"notification_types": 
[
{"notification_type": "trouble",
"editable": false,
"status": false,
"stopped_by": "ecid999997"
},
{"notification_type": "agreement",
"editable": true,
"status": false,
"stopped_by": "ecid999998"
},
{"notification_type": "sales",
"editable": true,
"status": true,
"stopped_by": null
}
]
}

Change Notification Settings of Contract(For partner user only)

Overview

Change notification setting in the designnated contract. This API can be used by Partner user only.

Classification

Update

API Operation Object

Notification

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_id

required

string

Target Contract ID

Request Body schema: application/json

notification_types

required

Array of objects

Array of notificaton settings

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/notifications/contracts/{contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/notifications/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/notifications/contracts/{contract_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"notification_types": 
[
{"notification_type": "maintenance",
"status": true
},
{"notification_type": "sales",
"status": false
}
]
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Workspace API

API for manage workspace(s).

Create Workspace

Overview

Create workspace in the designated contract.

Classification

Create

API Operation Object

Workspace

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

workspace_name required	string Workspace name. Single-byte alphanumeric characters, and !$&()+,-.;<=>@[]^_`{\|}~ can be used. String length must be between 1 and 50 characters.
description	string Descriptions for this workspace. String must be less than 255 characters.
contract_id	string Contract ID for workspace creation. This parameter can only be specified by Partner user. If specified by general user, the parameter will be ignored.

Responses

201

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/workspaces

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspaces

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspaces

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"workspace_name": "sample_workspace",
"description": "sample workspace",
"contract_id": "econ0000000001"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"workspace_id": "ws0000000001",
"workspace_name": "workspace_001",
"description": "sample workspace",
"contract_id": "econ0000000001"
}

List Workspaces

Overview

Get list of workspace. Only workspaces for which the user has access rights are output.

Classification

List

API Operation Object

Workspace

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

contract_id

string

Contract ID( Default is the Contract ID of API executing user. ).

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/workspaces

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspaces

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspaces

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ0000000001",
"workspaces": 
[
{"workspace_id": "ws0000000001",
"workspace_name": "xxxxxxxxxxxxxxxx",
"description": "xxxxxxxxxxxxxxxxxx",
"start_time": "2020-01-01 00:00:00"
},
{"workspace_id": "ws0000000002",
"workspace_name": "xxxxxxxxxxxxxxxx",
"description": "xxxxxxxxxxxxxxxxxx",
"start_time": "2020-01-01 00:00:00"
}
]
}

Get Workspace

Overview

Get information about a workspace.

Classification

API Operation Object

Workspace

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id

required

string

Target Workspace ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/workspaces/{workspace_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspaces/{workspace_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspaces/{workspace_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ0000000001",
"workspace_id": "ws0000000001",
"workspace_name": "xxxxxxxxxxxxx",
"description": "xxxxxxxxxxxxx",
"start_time": "2020-01-01 00:00:00",
"regions": 
[
{"region_name": "jp1",
"tenant_id": "xxxxxxxxxxxxx"
},
{"region_name": "jp2",
"tenant_id": "xxxxxxxxxxxxx"
}
],
"users": 
[
{"user_id": "ecid000000001",
"contract_id": "econ0000000001",
"contract_owner": true
},
{"user_id": "ecid000000002",
"contract_id": "econ0000000002",
"contract_owner": false
}
]
}

Delete Workspace

Overview

Delete workspace.
Only super user (contract owner user) and partner user can use this API.
If the user delete workspace, the all user's token who has role to this workspace are expired even though 1 hour has not passed.

Classification

Delete

API Operation Object

Workspace

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id

required

string

Target Workspace ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/workspaces/{workspace_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspaces/{workspace_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspaces/{workspace_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Update Workspace

Overview

Updates the description for the designated workspace.

Classification

Update

API Operation Object

Workspace

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id

required

string

Target Workspace ID

Request Body schema: application/json

description

required

string

New description of the workspace. String must be less than 255 characters.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/workspaces/{workspace_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspaces/{workspace_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspaces/{workspace_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"description": "string"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Add Workspace Role Assignment

Overview

Add role between user and workspace.
Contract owner user always have role to all workspaces in the contract.
Only super user (contract owner user) and partner user can use this API.

Classification

Modify

API Operation Object

Workspace

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

user_id required	string Target User ID
workspace_id required	string Target Workspace ID

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/workspace-roles

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspace-roles

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspace-roles

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "string",
"workspace_id": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user_id": "ecid1234567891",
"workspace_id": "ws0000000001",
"workspace_name": "testWorkspace001"
}

Delete Workspace Role Assignment

Overview

Delete role between user and workspace.
Contract owner user always have role to all workspaces in the contract.
Only super user with Workspace management permission and partner user can use this API.

Classification

Delete

API Operation Object

Workspace

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id required	string Target Workspace ID
user_id required	string Target User ID

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

delete/workspace-roles/workspaces/{workspace_id}/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspace-roles/workspaces/{workspace_id}/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspace-roles/workspaces/{workspace_id}/users/{user_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Change workspace ownership contract

Overview

Change the contract for owning the workspace.
Before executing this API, approval request for the target workspace must be registered and approved. See Create Workspace Migration Request for more info.
Only super user (contract owner user) and partner user can use this API.

Classification

Update

API Operation Object

Workspace

Synchronous / Asynchronous

Asynchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id

required

string

Target workspace ID

Request Body schema: application/json

contract_id

required

string

ID of the new contract to which the workspace will belong

Responses

202

Accepted

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/workspaces/{workspace_id}/contracts

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspaces/{workspace_id}/contracts

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspaces/{workspace_id}/contracts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econXXXXXXXXXX"
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Get workspace migration information

Overview

This API retrieves information regarding the migration of the specified workspace.

Classification

API Operation Object

Workspace

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

workspace_id

required

string

Target workspace ID

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/workspaces/{workspace_id}/migration

GL1 Endpoint

https://api.ntt.com/sss/api/v2/workspaces/{workspace_id}/migration

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/workspaces/{workspace_id}/migration

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"workspace_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"workspace_migration_request": 
{"already_migrated": false,
"status": "approved",
"approval_expire": "2018-12-31 00:00:00",
"destination_contract_id": "econxxxxxxxxx"
}
}

Update Login Ip Address Restriction users

Overview

Update the user assignment for login IP address restrictions.

Classification

Update

API Operation Object

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

contract_id	string Contract ID of the User to be Edited
users required	Array of objects

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/login-ip-address-restriction/users

GL1 Endpoint

https://api.ntt.com/sss/api/v2/login-ip-address-restriction/users

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/login-ip-address-restriction/users

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ0000000000",
"users": 
[
{"user_id": "ecid0000000000",
"restriction": true
}
]
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

List Contract Allowed Login Ip Address

Overview

Return a list of permitted login IP addresses assigned to the contract.

Classification

List

API Operation Object

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

query Parameters

contract_id

string

Contract ID ( Default is the Contract ID of API executing user. ).

Responses

200

Success

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

get/login-ip-address-restriction/login-ip-addresses

GL1 Endpoint

https://api.ntt.com/sss/api/v2/login-ip-address-restriction/login-ip-addresses

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/login-ip-address-restriction/login-ip-addresses

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ0000000000",
"ip_addresses": 
[
{"login_ip_address_id": "lgip0000000001",
"ip_address": "XXX.XXX.XXX.XXX(IP address)/XX(subnet mask)",
"description": "XXXXXXXXXX"
}
]
}

Create Contract Allowed Login Ip Address

Overview

Create a new permitted login IP address to the contract.

Classification

Create

API Operation Object

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

Request Body schema: application/json

contract_id	string Target Contract ID
ip_address required	string IP address and subnet mask in CIDR notation
description	string Description of the IP address

Responses

201

Created

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

post/login-ip-address-restriction/login-ip-addresses

GL1 Endpoint

https://api.ntt.com/sss/api/v2/login-ip-address-restriction/login-ip-addresses

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/login-ip-address-restriction/login-ip-addresses

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"contract_id": "econ0000000001",
"ip_address": "127.0.0.1/24",
"description": "Description of the IP address"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"login_ip_address_id": "lgip0000000001",
"contract_id": "econ0000000000",
"ip_address": "XXX.XXX.XXX.XXX(IP address)/XX(subnet mask)",
"description": "XXXXXXXXXX"
}

Delete Login-IP-Address

Overview

Delete a specific login IP address.

Classification

Delete

API Operation Object

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

login_ip_address_id

required

string

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

delete/login-ip-address-restriction/login-ip-addresses/{login_ip_address_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/login-ip-address-restriction/login-ip-addresses/{login_ip_address_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/login-ip-address-restriction/login-ip-addresses/{login_ip_address_id}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}

Update Login Ip Address Restriction Usage Setting for Contract

Overview

Update whether to use the login IP address restriction function for the specified contract. If this setting is disabled, all IP address restriction configurations will be disabled.

Classification

Update

API Operation Object

Contract

Synchronous / Asynchronous

Synchronous

Authorizations:

X-Auth-Token

path Parameters

contract_id

required

string

Target Contract ID (econXXXXXXXXX)

Request Body schema: application/json

enabled

required

boolean

If true, the IP address restriction is enabled; If false, disabled.

Responses

204

No Content

400

Invalid request

401

Unauthorized

403

Not permitted for this user

404

Not found a specified resource

405

Method not allowed

409

Designated resource conflicted with existing resource

put/login-ip-address-restriction/contracts/{contract_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v2/login-ip-address-restriction/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v2/login-ip-address-restriction/contracts/{contract_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"enabled": true
}

Response samples

Content type

application/json

Unauthorized Error

Copy

Expand all Collapse all


{"code": 401,
"title": "Unauthorized",
"message": "Invalid token."
}