Cloudflare.ZeroTrustRiskScoringIntegration (Cloudflare v0.5.0)

Copy Markdown View Source

Zero Trust Risk Scoring Integrations

Create new risk score integration.

POST /accounts/{account_id}/zt_risk_scoring/integrations

Responses

200 Create response.

Data is at body["result"]

{
  "account_tag": "*string*",
  "active": "*boolean*",
  "created_at": "*string*",
  "id": "*string*",
  "integration_type": "*string*",
  "reference_id": "*string*",
  "tenant_url": "*string*",
  "well_known_url": "*string*"
}
4XX Create failure response.
{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

List all risk score integrations for the account.

GET /accounts/{account_id}/zt_risk_scoring/integrations

Responses

200 List response.

Data is at body["result"]

[
  {
    "account_tag": "*string*",
    "active": "*boolean*",
    "created_at": "*string*",
    "id": "*string*",
    "integration_type": "*string*",
    "reference_id": "*string*",
    "tenant_url": "*string*",
    "well_known_url": "*string*"
  }
]
4XX List failure response.
{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get risk score integration by reference id.

GET /accounts/{account_id}/zt_risk_scoring/integrations/reference_id/{reference_id}

Responses

200 Get response.

Data is at body["result"]

{
  "account_tag": "*string*",
  "active": "*boolean*",
  "created_at": "*string*",
  "id": "*string*",
  "integration_type": "*string*",
  "reference_id": "*string*",
  "tenant_url": "*string*",
  "well_known_url": "*string*"
}
4XX Get failure response.
{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Update a risk score integration.

PUT /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}

Overwrite the reference_id, tenant_url, and active values with the ones provided.

Responses

200 Update response.

Data is at body["result"]

{
  "account_tag": "*string*",
  "active": "*boolean*",
  "created_at": "*string*",
  "id": "*string*",
  "integration_type": "*string*",
  "reference_id": "*string*",
  "tenant_url": "*string*",
  "well_known_url": "*string*"
}
4XX Update failure response.
{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get risk score integration by id.

GET /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}

Responses

200 Get response.

Data is at body["result"]

{
  "account_tag": "*string*",
  "active": "*boolean*",
  "created_at": "*string*",
  "id": "*string*",
  "integration_type": "*string*",
  "reference_id": "*string*",
  "tenant_url": "*string*",
  "well_known_url": "*string*"
}
4XX Get failure response.
{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Delete a risk score integration.

DELETE /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}

Responses

200 Delete response.

Data is at body["result"]

{}
4XX Delete failure response.
{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Summary

Functions

by_reference_id(reference_id, opts \\ [])
client(opts \\ [])
create(body, opts \\ [])
create!(body, opts \\ [])
delete(id, opts \\ [])
delete!(id, opts \\ [])
index(opts \\ [])
index!(opts \\ [])
path_for(id, opts \\ [])
show(id, opts \\ [])
show!(id, opts \\ [])
update(id, body, opts \\ [])
update!(id, body, opts \\ [])

Functions

by_reference_id(reference_id, opts \\ [])

client(opts \\ [])

@spec client(Restlax.Resource.action_options()) :: module()

create(body, opts \\ [])

@spec create(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  {:ok, map()} | {:error, term()}

create!(body, opts \\ [])

@spec create!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  map() | no_return()

delete(id, opts \\ [])

@spec delete(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

delete!(id, opts \\ [])

@spec delete!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

index(opts \\ [])

@spec index(opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

index!(opts \\ [])

@spec index!(opts :: Restlax.Resource.action_options()) :: map() | no_return()

path_for(id, opts \\ [])

@spec path_for(term(), [{:action, String.t()}]) :: String.t()

show(id, opts \\ [])

@spec show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

show!(id, opts \\ [])

@spec show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

update(id, body, opts \\ [])

@spec update(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: {:ok, map()} | {:error, term()}

update!(id, body, opts \\ [])

@spec update!(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: map() | no_return()