Smart Data Platform SSS API v2 List (3.0.0)
Download OpenAPI specification:Download
Smart Data Platform SSS (Shared Support Service) provides controls of your contract / user / tenant / API keys and permissions. Following list shows SSS API v2.
- 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.
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 |
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
Success
Invalid request
Unauthorized
Not permitted for this user
Not found a specified resource
Method not allowed
GL1 Endpoint
Regional Endpoint
Response samples
- 200
- 401
{- "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",
- "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:
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
No Content
Invalid request
Unauthorized
Not permitted for this user
Not found a specified resource
Method not allowed
Designated login conflicts existing user
GL1 Endpoint
Regional Endpoint
Request samples
- Payload
{- "mail_address": "test@ntt.com"
}
Response samples
- 401
- 404
Unauthorized Error
{- "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
No Content
Invalid request
Unauthorized
Not permitted for this user
Not found a specified resource
Method not allowed
Designated login conflicts existing user
GL1 Endpoint
Regional Endpoint
Response samples
- 401
- 404
Unauthorized Error
{- "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
Success
Invalid request
Unauthorized
Not permitted for this user
Not found a specified resource
Method not allowed
GL1 Endpoint
Regional Endpoint
Response samples
- 200
- 401
{- "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:
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 |