Overview（Coming soon）
This API manages the configuration of source IP addresses used by the role manager accounts (accounts applied for via the business portal, or equivalent accounts issued by our company staff in charge).
When applying from the business portal or when issued by our company staff in charge, the role manager accounts are definitely registered with the source IP address of that account. #1
- #1 A account issued after August 2025. All accounts issued before August 2025, the default value have been be set to 0.0.0.0/0.
Conceptual figure
Follow figure explains authorization control of IP address.
Caution of using role manager's API key
The role manager accounts can use all API. You should use the role manager's API key when you use manager's API -e.g. IAM API. We recommend using API key of child API user when you use other API.
How to use this API
The cases you would like to manage source IP addresses of a role manager accounts by using this API are as follows:
1.When you would like to change the current setting
e.g）The IP address of the client server is going to change from until now use
2.When you would like to refer to the current setting
e.g）When you have forgotten the actual settings and want to see which IP addresses can use your account.
Resource URL
Please use the global common domain, depending on the circumstances of your available points, and then connect to the nearest API gateway.
1.Base Path(Global Load Balance)
https://api.ntt.com/v1/manage-allowed-ipaddress
Resource Information
| Key | Value |
|---|---|
| Response Format | JSON |
| Authorization(OAuth) | Yes |
| Rate Limiting #1 | Yes |
- #1 appropriate flow restriction
To change the current setting
PUT /v1/manage-allowed-ipaddress
Request Parameters
| Name | Description | Type | Mandatory | Notes |
|---|---|---|---|---|
| allowedIpAddresses | The source IP address used by this account | JSON | Yes | #Only Ipv4 #By CIDR notation #Multiple IP address can be set by separating them with ,(a comma) up to 100 addresses |
Example Request
Content-Type: application/json; charset=utf-8
PUT /v1/manage-allowed-ipaddress
{
"allowedIpAddresses":"10.10.10.10/32,172.168.10.0/24"
}
Response Parameters
| Name | Description | type | mandatory |
|---|---|---|---|
| allowedIpAddresses | New IP address | String | Yes |
Example Result
{
"allowedIpAddresses":"10.10.10.10/32,172.168.10.0/24"
}
To refer to the current setting
GET /v1/manage-allowed-ipaddress
Request Parameters
none
Example Request
GET /v1/manage-allowed-ipaddress
Response Parameters
| Name | Description | type | mandatory |
|---|---|---|---|
| allowedIpAddresses | Currently set IP address | String | Yes |
Example Result
{
"allowedIpAddresses":"10.10.10.10/32,172.168.10.0/24"
}