Documentation Powered by ReDoc

Smart Data Platform SSS API v1.0 List (3.0.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/inquiry/ License: © NTT Communications Corporation All Rights Reserved. Terms of Service

Introduction

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


⚠️ The v1.0 API is deprecated. If you wish to use SSS APIs, please use v2 APIs. Also, if you are currently using the v1.0 API, please migrate to the v2 API. The date of API decommissioning is to be determined

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

  • Get

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/v1.0/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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",
  • "api_only": false
}

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

new_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.

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/v1.0/users/{user_id}

Regional Endpoint

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "login_id": "test001",
  • "mail_address": "test@ntt.com",
  • "new_password": "Ale39bao"
}

Response samples

Content type
application/json
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/v1.0/users/{user_id}

Regional Endpoint

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

Response samples

Content type
application/json
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/v1.0/users

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contract_id": "econ1000002891",
  • "users":
    [
    ]
}

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.

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/v1.0/users

Regional Endpoint

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

Request samples

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
{}

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/v1.0/keys/{user_id}

Regional Endpoint

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

Response samples

Content type
application/json
Example
example-user-api-key
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/v1.0/users/{user_id}/auto-role-assignment

Regional Endpoint

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 401,
  • "title": "Unauthorized",
  • "message": "Invalid token."
}

Tenant API

API for manage tenant(s).

Create Tenant


Overview

  • Create new tenant in the designated contract. Only super user (contract owner user) can use this API. This API does not allow you to create tenants in different regions in the same workspace. If you want to create tenants for different regions in the same workspace, please use version 2 of the create tenant API.

Classification

  • Create

API Operation Object

  • Tenant

Synchronous / Asynchronous

  • Synchronous
Authorizations:
X-Auth-Token
Request Body schema: application/json
tenant_name
required
string

New tenant's tenant name. This name need to be unique globally. Alphanumeric characters and !$&()+,-.;<=>@[]^_`{|}~ can be used. String length must be between 1 and 50 characters.

description
required
string

Description for this tenant. String must be less than 255 characters.

region
required
string

Region this tenant belongs to.

contract_id
string

Contract which new tenant belongs to. If this parameter is not designated, API user's contract implicitly designated. Required for partner users.

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/v1.0/tenants

Regional Endpoint

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenant_name": "new_project",
  • "description": "To use projectA",
  • "region": "jp-east",
  • "contract_id": "econ1111123456"
}

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/v1.0/tenants

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contract_id": "econ1000002760",
  • "tenants":
    [
    ]
}

Get Tenant


Overview

  • Get information about a tenant.

Classification

  • Get

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/v1.0/tenants/{tenant_id}

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenant_id": "//sss-jp1-ecl.api.ntt.com/api/v2/tenants/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":
    [
    ],
  • "brand_id": "ecl2",
  • "workspace_id": "ws0000000001"
}

Delete Tenant


Overview

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

Classification

  • Delete

API Operation Object

  • Tenant

Synchronous / Asynchronous

  • Synchronous
Authorizations:
X-Auth-Token
path Parameters
tenant_id
required
string

ID of the tenant

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/tenants/{tenant_id}

GL1 Endpoint

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

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 401,
  • "title": "Unauthorized",
  • "message": "Invalid token."
}

Update Tenant


Overview

  • Update description tenant in the designated contract.

Classification

  • Update

API Operation Object

  • Tenant

Synchronous / Asynchronous

  • Synchronous
Authorizations:
X-Auth-Token
path Parameters
tenant_id
required
string

ID of the tenant

Request Body schema: application/json
description
required
string

Description for this tenant. 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/tenants/{tenant_id}

GL1 Endpoint

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

Regional Endpoint

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 401,
  • "title": "Unauthorized",
  • "message": "Invalid token."
}

Role API

API for manage role.

Create Role


Overview

  • Create role between a user and a tenant. With role, users can access to the tenants.

Classification

  • Create

API Operation Object

  • Role

Synchronous / Asynchronous

  • Synchronous
Authorizations:
X-Auth-Token
Request Body schema: application/json
user_id
required
string

User which have new role.

tenant_id
required
string

Tenant which the user have role.

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/roles

GL1 Endpoint

https://api.ntt.com/sss/api/v1.0/roles

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/roles

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "user_id": "ecid1234567891",
  • "tenant_id": "91b5c7c09cbd45caa3c146fd67ae471e"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "user_id": "test001",
  • "region_id": "1789d1",
  • "region_name": "jp-east",
  • "tenant_id": "91b5c7c09cbd45caa3c146fd67ae471e",
  • "tenant_name": "testTenant001",
  • "role_name": "_member_",
  • "workspace_id": "ws0000000001"
}

Delete Role


Overview

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

Classification

  • Delete

API Operation Object

  • Role

Synchronous / Asynchronous

  • Synchronous
Authorizations:
X-Auth-Token
path Parameters
tenant_id
required
string

Delete target tenant's tenant id.

user_id
required
string

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

409

Designated resource conflicted with existing resource

delete/roles/tenants/{tenant_id}/users/{user_id}

GL1 Endpoint

https://api.ntt.com/sss/api/v1.0/roles/tenants/{tenant_id}/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/roles/tenants/{tenant_id}/users/{user_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 401,
  • "title": "Unauthorized",
  • "message": "Invalid token."
}

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/v1.0/contracts

Regional Endpoint

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

Response samples

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

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.

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/v1.0/contracts

Regional Endpoint

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

Request samples

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
Copy
 Expand all Collapse all
{
  • "code": 401,
  • "title": "Unauthorized",
  • "message": "Invalid token."
}

Get Contract Information


Overview

  • Get the information of the designated contract.

Classification

  • Get

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/v1.0/contracts/{contract_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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"
}

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/v1.0/contracts/{contract_id}

Regional Endpoint

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

Response samples

Content type
application/json
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/v1.0/contracts/{contract_id}

Regional Endpoint

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

Request samples

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
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/v1.0/contracts/{contract_id}/owner

Regional Endpoint

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

Request samples

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

Response samples

Content type
application/json
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

  • Get

API Operation Object

  • Contracts

Synchronous / Asynchronous

  • Synchronous

HTTP Request Path

  • Specify query parameters as below
    • /api/v1.0/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, 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/v1.0/search/contracts

Regional Endpoint

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

Response samples

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

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/v1.0/channels

Regional Endpoint

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

Response samples

Content type
application/json
Example
example-channels
Copy
 Expand all Collapse all
{
  • "channels":
    [
    ]
}

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

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

post/iam/groups

GL1 Endpoint

https://api.ntt.com/sss/api/v1.0/iam/groups

Regional Endpoint

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

Request samples

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

409

Designated resource conflicted with existing resource

get/iam/groups

GL1 Endpoint

https://api.ntt.com/sss/api/v1.0/iam/groups

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contract_id": "econXXXXXXX",
  • "iam_groups":
    [
    ]
}

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/v1.0/iam/roles

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contract_id": "econ1234567890",
  • "iam_roles":
    [
    ]
}

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

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/v1.0/iam/roles

Regional Endpoint

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contract_id": "econXXXXXXXXX",
  • "iam_role_name": "new_role",
  • "description": "new role",
  • "resources":
    [
    ]
}

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":
    [
    ]
}

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/v1.0/iam/groups/{iam_group_id}/users

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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":
    [
    ]
}

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

  • Get

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/v1.0/iam/roles/{iam_role_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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":
    [
    ]
}

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/v1.0/iam/roles/{iam_role_id}

Regional Endpoint

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

Response samples

Content type
application/json
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

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/v1.0/iam/roles/{iam_role_id}

Regional Endpoint

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "iam_role_name": "test_role",
  • "description": "test role",
  • "resources":
    [
    ]
}

Response samples

Content type
application/json
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/v1.0/iam/groups/{iam_group_id}/roles/{iam_role_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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/v1.0/iam/groups/{iam_group_id}/roles/{iam_role_id}

Regional Endpoint

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

Response samples

Content type
application/json
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/v1.0/iam/groups/{iam_group_id}/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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/v1.0/iam/groups/{iam_group_id}/users/{user_id}

Regional Endpoint

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

Response samples

Content type
application/json
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/v1.0/iam/groups/{iam_group_id}

Regional Endpoint

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

Response samples

Content type
application/json
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

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/v1.0/iam/groups/{iam_group_id}

Regional Endpoint

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "iam_group_name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
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/v1.0/approval-requests

Regional Endpoint

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

Response samples

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

Get Approval Request


Overview

  • Get information of approval request.

Classification

  • Get

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/v1.0/approval-requests/{request_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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":
    [
    ],
  • "descriptions":
    [
    ],
  • "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/v1.0/approval-requests/{request_id}

Regional Endpoint

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 401,
  • "title": "Unauthorized",
  • "message": "Invalid token."
}

Billing API

Billing API v1 is no longer available; please use Billing API v2. Please refer to this link for details.

Transaction API

API for Transaction.

Get Result of Transaction


Overview

  • Get the result of the transaction.

Classification

  • Get

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/v1.0/transactions/{transaction_id}

Regional Endpoint

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

Response samples

Content type
application/json
Example
example-inprogress
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/v1.0/iam/contract-groups

Regional Endpoint

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

Request samples

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/v1.0/iam/contract-groups

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contract_id": "econXXXX",
  • "contract_group":
    {
    }
}

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/v1.0/iam/contract-groups/{contract_group_id}

Regional Endpoint

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contract_group_name": "update_group",
  • "description": "update group"
}

Response samples

Content type
application/json
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/v1.0/iam/contract-groups/{contract_group_id}

Regional Endpoint

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

Response samples

Content type
application/json
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

  • Get

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/v1.0/iam/contract-groups/{contract_group_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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":
    [
    ],
  • "users":
    [
    ]
}

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/v1.0/iam/contract-groups/{contract_group_id}/contracts/{contract_id}

Regional Endpoint

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

Response samples

Content type
application/json
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/v1.0/iam/contract-groups/{contract_group_id}/contracts/{contract_id}

Regional Endpoint

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

Response samples

Content type
application/json
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/v1.0/iam/contract-groups/{contract_group_id}/users/{user_id}

Regional Endpoint

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

Response samples

Content type
application/json
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/v1.0/iam/user-types/users

Regional Endpoint

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

Response samples

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

Get User Type Information


Overview

  • Show User Type Detail Information of the designated user.

Classification

  • Get

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/v1.0/iam/user-types/users/{user_id}

Regional Endpoint

https://sss-jp1-ecl.api.ntt.com/api/v1.0/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":
    [
    ]
}

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
tenant Tenant 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" "tenant" "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/v1.0/iam/user-types/users/{user_id}

Regional Endpoint

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "super_user": true,
  • "grant":
    [
    ]
}

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 tenant operation: [user]",
  • "error_code": "RequiredOperationAuthInsufficient:tenant:user"
}

Menu API

API for manage available menus.

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/v1.0/iam/menus/users/{user_id}

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "user_id": "ecidXXXXXXXXXX",
  • "menus":
    [
    ]
}

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/v1.0/iam/menus/users/{user_id}

Regional Endpoint

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

Request samples

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

Response samples

Content type
application/json
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/v1.0/notifications/users/{user_id}

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "user_id": "ecid999999",
  • "notification_types":
    [
    ]
}

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/v1.0/notifications/users/{user_id}

Regional Endpoint

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

Request samples

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

Response samples

Content type
application/json
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/v1.0/notifications/contracts/{contract_id}

Regional Endpoint

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contract_id": "econ9999999999",
  • "notification_types":
    [
    ]
}

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/v1.0/notifications/contracts/{contract_id}

Regional Endpoint

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 401,
  • "title": "Unauthorized",
  • "message": "Invalid token."
}