doc-exports/docs/iam/api-ref/iam_02_0030.html

Querying the ACL for API Access

Function

This API is used to query the ACL for API access.

URI

GET /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/api-acl-policy

Table 1 URI parameters

Parameter	Mandatory	Type	Description
domain_id	Yes	String	Domain ID.

Request Parameters

Table 2 Parameters in the request header

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Token with Security Administrator permissions.

Response Parameters

Table 3 Parameters in the response body

Parameter	Type	Description
api_acl_policy	object	ACL for API access.

Table 4 api_acl_policy

Parameter	Type	Description
allow_address_netmasks	Array of objects	IPv4 CIDR blocks from which API access is allowed.
allow_ip_ranges	Array of objects	IP address ranges from which API access is allowed.
allow_vpc_endpoints	Array of objects	VPC endpoints from which API access is allowed.

Table 5 allow_address_netmasks

Parameter	Type	Description
address_netmask	String	IPv4 CIDR block, for example, 192.168.0.1/24.
description	String	Description about the IPv4 CIDR block.

Table 6 allow_ip_ranges

Parameter	Type	Description
description	String	Description about an IP address range.
ip_range	String	IP address range, for example, 0.0.0.0-255.255.255.255.

Table 7 allow_vpc_endpoints

Parameter	Type	Description
vpc_endpoint_id	String	VPC endpoint ID, for example, 8di3jdu38d7jhfa7df68adyfiadfia6d.
description	String	Description about the VPC endpoint.

Example Request

GET https://sample.domain.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/api-acl-policy

Example Response

Status code: 200

The request is successful.

{ 
  "api_acl_policy" : { 
    "allow_ip_ranges" : [ { 
      "ip_range" : "0.0.0.0-255.255.255.255", 
      "description" : "" 
    }, { 
      "ip_range" : "0.0.0.0-255.255.255.255", 
      "description" : "" 
    } ], 
    "allow_address_netmasks" : [ { 
      "address_netmask" : "192.168.0.1/24", 
      "description" : "" 
    }, { 
      "address_netmask" : "192.168.0.1/24", 
      "description" : "" 
    } ] ,
     "allow_vpc_endpoints": [
       {
       "vpc_endpoint_id": "8di3jdu38d7jhfa7df68adyfiadfia6d",
       "description": ""
        },
        {
         "vpc_endpoint_id": "23i3jdu38d7jhfa7df68adyfiadfia8j",
         "description": ""
          }
        ]
  } 
}

Status code: 403

Access denied.

• Example 1

{ 
   "error_msg" : "You are not authorized to perform the requested action.", 
   "error_code" : "IAM.0002" 
 }

• Example 2

{ 
   "error_msg" : "Policy doesn't allow %(actions)s to be performed.", 
   "error_code" : "IAM.0003" 
 }

Status code: 404

The requested resource cannot be found.

{ 
  "error_msg" : "Could not find %(target)s: %(target_id)s.", 
  "error_code" : "IAM.0004" 
}

Status code: 500

Internal server error.

{ 
  "error_msg" : "An unexpected error prevented the server from fulfilling your request.", 
  "error_code" : "IAM.0006" 
}

Status Codes

Status Code	Description
200	The request is successful.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.
500	Internal server error.

Parent topic: Security Settings