Test Source Ip

TestSourceIP checks whether a given IP address would be allowed by the specified CIDR allowlist rules.

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

TestSourceIP

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.SessionSettings.TestSourceIP(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.TestSourceIPResponse != nil {
        // handle response
    }
}

200

{
  "allowed": true,
  "checkedIp": "<string>",
  "details": {
    "code": 123,
    "details": [
      {
        "@type": "<string>"
      }
    ],
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The TestSourceIPRequest message.

allowCidr · string[] | null

The CIDR allowlist rules to test against. If empty, uses the tenant's current allowlist. Accepts IPv4 (e.g. 10.0.0.0/24) or IPv6 (e.g. 2001:db8::/32) CIDRs.

sourceIp · string

if unset, uses the source IP of the request. Accepts IPv4 (e.g. 10.0.0.5) or IPv6 (e.g. 2001:db8::1) addresses, optionally with a CIDR prefix.

Response

200 - application/json

Successful response

The TestSourceIPResponse message.

allowed · boolean

Whether the tested IP address is allowed by the CIDR rules.

checkedIp · string

The IP address that was checked, either from the request or inferred from the caller.

details · Status · object

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.

Show child attributes