Documentation Powered by ReDoc

Remote Access User - Flexible Security Service API References (1.4.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

manage remote access users (Paloalto users)

Authentication

X-Auth-Token

Security Scheme Type API Key
Header parameter name: {keystone_token}

remote-access-user

Get Remote Access Users

Get remote access user resources.

Authorizations:
X-Auth-Token
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.

userId
string ^[a-zA-Z0-9-_]{1,31}$

A remote access user name of the resource.

fraGroupId
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

ID of the FRA group to which the resource belongs.

serviceGroupId
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

ID of the service group to which the resource belongs.

tenantId
string ^[a-fA-F0-9]{32}$

ID of the tenant to which the resource belongs.

includeUserGroups
boolean
Default: false

Whether to include userGroups field in the response.

limit
integer [ 1 .. 32000 ]
Default: 32000

Maximum number of remote access users to return.

offset
integer >= 0
Default: 0

Offset for pagination.

orderBy
string
Default: "userId"
Value: "userId"

Field to sort by.

order
string
Default: "asc"
Enum: "asc" "desc"

Sort direction.

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

503

Service Unavailable

get/v1/remote-access-users
https://api.ntt.com/fsec-ers/v1/remote-access-users

Response samples

Content type
application/json
Example
WithUserGroups
Copy
 Expand all Collapse all
{
  • "remoteAccessUsers":
    [
    ],
  • "pagination":
    {
    },
  • "truncation":
    {
    }
}

Create Remote Access Users

Create multiple remote access users resources at once.

Authorizations:
X-Auth-Token
Request Body schema: application/json
remoteAccessUsers
required
object (RemoteAccessUserCreateRequest)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

503

Service Unavailable

post/v1/remote-access-users
https://api.ntt.com/fsec-ers/v1/remote-access-users

Request samples

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

Response samples

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

Update Remote Access Users

Update multiple remote access users resources at once.

Authorizations:
X-Auth-Token
Request Body schema: application/json
remoteAccessUsers
required
object (RemoteAccessUserUpdateRequest)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

503

Service Unavailable

patch/v1/remote-access-users
https://api.ntt.com/fsec-ers/v1/remote-access-users

Request samples

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

Response samples

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

Delete Remote Access Users

Delete multiple remote access user resources at once.

Authorizations:
X-Auth-Token
Request Body schema: application/json
remoteAccessUsers
required
object (RemoteAccessUserDeleteRequest)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

503

Service Unavailable

post/v1/remote-access-users/delete
https://api.ntt.com/fsec-ers/v1/remote-access-users/delete

Request samples

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

Response samples

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

Get Remote Access User

Get remote access user resource.

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

get/v1/remote-access-users/{user_id}
https://api.ntt.com/fsec-ers/v1/remote-access-users/{user_id}

Response samples

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