Test Source IP

Test Source Ip

post/api/v1/settings/session/test-source-ip

Invokes the c1.api.settings.v1.SessionSettingsService.TestSourceIP method.

Body Parameters

allowCidrarray of string

optional

The allowCidr field.

sourceIpstring

optional

if unset, uses the source IP of the request

Returns

allowedboolean

optional

The allowed field.

checkedIpstring

optional

The checkedIp field.

detailsobject

optional

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

Hide ParametersShow Parameters

codenumber

optional

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

formatint32

detailsarray of object

optional

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

messagestring

optional

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

Request example cURL

curl https://{tenantDomain}.conductor.one/api/v1/settings/session/test-source-ip \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"

200 Example

{
  "allowed": true,
  "checkedIp": "checkedIp",
  "details": {
    "code": 0,
    "details": [
      {
        "@type": "@type"
      }
    ],
    "message": "message"
  }
}