Documentation Powered by ReDoc

Captive-Portal-Policy - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

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

Captive-Portal-Policy resource.

Authentication

X-Auth-Token

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

captive-portal-policy

Get Captive-Portal-Policies

Get Captive-Portal-Policy 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.

name
string ^[a-zA-Z]{1}[a-zA-Z0-9-\_\.]{0,30}$

A name of the resource.

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

The Cell-Group ID which the resource belongs.

action
string
Enum: "none" "captive-portal"

The action of the policy.

_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" "name" "action" "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/captive-portal-policies
https://api.ntt.com/dsigw-erg/v1/captive-portal-policies

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "captivePortalPolicies":
    [
    ]
}

Create Captive-Portal-Policy

Create a Captive-Portal-Policy resource.

Authorizations:
X-Auth-Token
header Parameters
X-Auth-Token
string

The keystone token.

Request Body schema: application/json
captivePortalPolicy
required
object (CaptivePortalPolicyCreateRequest)

Captive-Portal-Policy create request schema. Either customUrlCategoryIds or urlCategoryNames is required.

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1/captive-portal-policies
https://api.ntt.com/dsigw-erg/v1/captive-portal-policies

Request samples

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

Response samples

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

Get Captive-Portal-Policy Details

Get a Captive-Portal-Policy resource.

Authorizations:
X-Auth-Token
path Parameters
captive_portal_policy_id
required
string

The ID of the Captive-Portal-Policy resource.

header Parameters
X-Auth-Token
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/captive-portal-policies/{captive_portal_policy_id}
https://api.ntt.com/dsigw-erg/v1/captive-portal-policies/{captive_portal_policy_id}

Response samples

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

Update Captive-Portal-Policy

Update a Captive-Portal-Policy resource.

Authorizations:
X-Auth-Token
path Parameters
captive_portal_policy_id
required
string

The ID of the Captive-Portal-Policy resource.

header Parameters
X-Auth-Token
string

The keystone token.

Request Body schema: application/json
captivePortalPolicy
required
object (CaptivePortalPolicyUpdateRequest)

Captive-Portal-Policy update request schema.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/captive-portal-policies/{captive_portal_policy_id}
https://api.ntt.com/dsigw-erg/v1/captive-portal-policies/{captive_portal_policy_id}

Request samples

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

Response samples

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

Delete Captive-Portal-Policy

Delete a Captive-Portal-Policy resource.

Authorizations:
X-Auth-Token
path Parameters
captive_portal_policy_id
required
string

The ID of the Captive-Portal-Policy resource.

header Parameters
X-Auth-Token
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/captive-portal-policies/{captive_portal_policy_id}
https://api.ntt.com/dsigw-erg/v1/captive-portal-policies/{captive_portal_policy_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 400,
  • "errorMessage": "Invalid request",
  • "moreInfo": "{{moreInfo}}"
}