Auth0.Management.DeviceCredentials (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of DeviceCredentials.

endpoint

/api/v2/device-credentials
/api/v2/device-credentials/{id}

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

create(params, config)

Create a device public key credential.

delete(id, config)

Delete a device credential.

list(params, config)

Retrieve device credentials.

Link to this section Types

config()

Specs

config() :: Auth0.Config.t()

error()

Specs

error() :: {:error, integer(), term()} | {:error, term()}

id()

Specs

id() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

create(params, config)

Specs

create(Auth0.Management.DeviceCredentials.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.DeviceCredential.t(), response_body()} | error()

Create a device public key credential.

see

https://auth0.com/docs/api/management/v2/#!/Device_Credentials/post_device_credentials

delete(id, config)

Specs

delete(id(), config()) :: {:ok, String.t(), response_body()} | error()

Delete a device credential.

see

https://auth0.com/docs/api/management/v2/#!/Device_Credentials/delete_device_credentials_by_id

list(params, config)

Specs

list(Auth0.Management.DeviceCredentials.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.DeviceCredentials.t(), response_body()} | error()

Retrieve device credentials.

see

https://auth0.com/docs/api/management/v2/#!/Device_Credentials/get_device_credentials