User-Id-Agent - Flexible Secure Gateway API References (1.10.0)
Download OpenAPI specification:Download
User-ID agents.
Get User-Id-Agent
Get User-Id-Agent resources.
Authorizations:
query Parameters
| id | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource. |
| cellGroupId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the cell group. |
| _limit | integer >= 1 The maximum number of items to return. |
| _offset | integer >= 0 The number of items to skip before starting to return results. |
| _order_by | Array of strings Items Enum: "id" "ipAddress" "port" "cellGroupId" "tenantId" "createdAt" "updatedAt" Sort keys. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
get/v1/user-id-agents
https://api.ntt.com/dsigw-erg/v1/user-id-agents
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "userIdAgents": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "ipAddress": "192.0.2.1",
- "port": 5007,
- "tenantId": "1234567890abcdef1234567890abcdef",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}, - {
- "id": "12345678-1234-1234-1234-1234567890a2",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "ipAddress": "192.0.2.2",
- "port": 5007,
- "tenantId": "1234567890abcdef1234567890abcdef",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}
]
}Create User-Id-Agent
Create a User-Id-Agent resource.
Authorizations:
header Parameters
| X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
| userIdAgent required | object (UserIdAgentCreateRequest) User-ID Agent create request schema. |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
500
Internal Server Error
post/v1/user-id-agents
https://api.ntt.com/dsigw-erg/v1/user-id-agents
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "userIdAgent": {
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "ipAddress": "192.0.2.1",
- "port": 5007
}
}Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
Copy
Expand all Collapse all {- "userIdAgent": {
- "id": "12345678-1234-1234-1234-1234567890ab",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "ipAddress": "192.0.2.1",
- "port": 5007,
- "operationId": "12345678-1234-1234-1234-1234567890ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}
}Get User-Id-Agent Details
Get a User-Id-Agent resource.
Authorizations:
path Parameters
| user_id_agent_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the User-Id-Agent. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
get/v1/user-id-agents/{user_id_agent_id}
https://api.ntt.com/dsigw-erg/v1/user-id-agents/{user_id_agent_id}
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "userIdAgent": {
- "id": "12345678-1234-1234-1234-1234567890ab",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "ipAddress": "192.0.2.1",
- "port": 5007,
- "tenantId": "1234567890abcdef1234567890abcdef",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}
}Update User-Id-Agent
Update a User-Id-Agent resource.
Authorizations:
path Parameters
| user_id_agent_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the User-Id-Agent. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
| userIdAgent required | object (UserIdAgentUpdateRequest) User-ID Agent update request schema. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
patch/v1/user-id-agents/{user_id_agent_id}
https://api.ntt.com/dsigw-erg/v1/user-id-agents/{user_id_agent_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "userIdAgent": {
- "ipAddress": "192.0.2.2"
}
}Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "userIdAgent": {
- "id": "12345678-1234-1234-1234-1234567890ab",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "ipAddress": "192.0.2.2",
- "port": 5007,
- "operationId": "12345678-1234-1234-1234-1234567890ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}
}Delete User-Id-Agent
Delete a User-Id-Agent resource.
Authorizations:
path Parameters
| user_id_agent_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the User-Id-Agent. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
delete/v1/user-id-agents/{user_id_agent_id}
https://api.ntt.com/dsigw-erg/v1/user-id-agents/{user_id_agent_id}
Response samples
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "errorCode": 400,
- "errorMessage": "Invalid request",
- "moreInfo": "{{moreInfo}}"
}