Skip to main content
POST
/
api
/
v1
/
settings
/
session
/
test-source-ip
TestSourceIP
package main

import(
	"context"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	"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
    }
}
{
  "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 allowCidr field.

​
sourceIp
string | null

if unset, uses the source IP of the request

Response

200 - application/json

Successful response

The TestSourceIPResponse message.

​
allowed
boolean | null

The allowed field.

​
checkedIp
string | null

The checkedIp field.

​
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.