Cloudflare.UserApiToken (Cloudflare v0.4.0) View Source

User API Tokens

Create Token

POST /user/tokens

Create a new access token.

Responses

200 Create Token response

Data is at body["result"]

{
  "condition": {
    "request_ip": {
      "in": null,
      "not_in": null
    }
  },
  "expires_on": "*string*",
  "id": "*string*",
  "issued_on": "*string*",
  "last_used_on": "*string*",
  "modified_on": "*string*",
  "name": "*string*",
  "not_before": "*string*",
  "policies": [
    {
      "effect": null,
      "id": null,
      "permission_groups": null,
      "resources": null
    }
  ],
  "status": "*string*",
  "value": "*string*"
}

4XX Create Token response failure

{
  "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 Tokens

GET /user/tokens

List all access tokens you created.

Responses

200 List Tokens response

Data is at body["result"]

[
  {
    "condition": {
      "request_ip": null
    },
    "expires_on": "*string*",
    "id": "*string*",
    "issued_on": "*string*",
    "last_used_on": "*string*",
    "modified_on": "*string*",
    "name": "*string*",
    "not_before": "*string*",
    "policies": [
      null
    ],
    "status": "*string*"
  }
]

4XX List Tokens response failure

{
  "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 Token Permission Groups

GET /user/tokens/permission_groups

Find all available permission groups for API Tokens

Responses

200 List Token Permission Groups response

Data is at body["result"]

[
  {
    "id": "*string*",
    "name": "*string*",
    "scopes": [
      "*string*"
    ]
  }
]

4XX List Token Permission Groups response failure

{
  "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*"
}

Verify Token

GET /user/tokens/verify

Test whether a token works.

Responses

200 Verify Token response

Data is at body["result"]

null

4XX Verify Token response failure

{
  "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 Token

PUT /user/tokens/{token_id}

Update an existing token.

Responses

200 Update Token response

Data is at body["result"]

{
  "condition": {
    "request_ip": {
      "in": null,
      "not_in": null
    }
  },
  "expires_on": "*string*",
  "id": "*string*",
  "issued_on": "*string*",
  "last_used_on": "*string*",
  "modified_on": "*string*",
  "name": "*string*",
  "not_before": "*string*",
  "policies": [
    {
      "effect": null,
      "id": null,
      "permission_groups": null,
      "resources": null
    }
  ],
  "status": "*string*"
}

4XX Update Token response failure

{
  "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*"
}

Token Details

GET /user/tokens/{token_id}

Get information about a specific token.

Responses

200 Token Details response

Data is at body["result"]

{
  "condition": {
    "request_ip": {
      "in": null,
      "not_in": null
    }
  },
  "expires_on": "*string*",
  "id": "*string*",
  "issued_on": "*string*",
  "last_used_on": "*string*",
  "modified_on": "*string*",
  "name": "*string*",
  "not_before": "*string*",
  "policies": [
    {
      "effect": null,
      "id": null,
      "permission_groups": null,
      "resources": null
    }
  ],
  "status": "*string*"
}

4XX Token Details response failure

{
  "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 Token

DELETE /user/tokens/{token_id}

Destroy a token.

Responses

200 Delete Token response

Data is at body["result"]

{
  "id": "*string*"
}

4XX Delete Token response failure

{
  "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*"
}

Roll Token

PUT /user/tokens/{token_id}/value

Roll the token secret.

Responses

200 Roll Token response

Data is at body["result"]

"*string*"

4XX Roll Token response failure

{
  "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*"
}

Link to this section Summary

Functions

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 \\ [])

verify(opts \\ [])

Link to this section Functions

client(opts \\ [])

Specs

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

create(body, opts \\ [])

Specs

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

create!(body, opts \\ [])

Specs

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

delete(id, opts \\ [])

Specs

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

delete!(id, opts \\ [])

Specs

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

index(opts \\ [])

Specs

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

index!(opts \\ [])

Specs

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

path_for(id, opts \\ [])

Specs

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

show(id, opts \\ [])

Specs

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

show!(id, opts \\ [])

Specs

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

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

Specs

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

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

Specs

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