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

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 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:
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-{region_name}-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,
  • "api_availability": true,
  • "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:
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-{region_name}-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:
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-{region_name}-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:
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-{region_name}-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:
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-{region_name}-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:
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-{region_name}-ecl.api.ntt.com/api/v1.0/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:
path Parameters
user_id
required
string