Struct ClientIdentities 

pub struct ClientIdentities<'a> { /* private fields */ }

Client identity routes, from Client::client_identities.

With a personal key you see and change only your own identities (all of them as an Admin). A zone key has no access: every route answers ErrorCode::Forbidden.

Implementations

impl<'a> ClientIdentities<'a>

pub async fn list( &self, filter: &ClientIdentityFilter, ) -> Result<Vec<ClientIdentity>>

The caller’s identities, all at once (Core does not paginate them).

GET /api/v1/client-identities

pub async fn get(&self, identity: &str) -> Result<ClientIdentity>

One identity, by uuid or by its identify value (e.g. 203.0.113.10).

GET /api/v1/client-identities/:ref

Errors

• ErrorCode::NotFound if there is no such identity.
• ErrorCode::Forbidden if it belongs to another user.

Examples

let identity = client.client_identities().get("203.0.113.10").await?;
println!("{} is {}", identity.identify, identity.uuid);

pub async fn create( &self, identity: &NewClientIdentity, ) -> Result<ClientIdentity>

Creates an identity owned by the caller; Relay starts recognising the client. For Hostname/Path the returned identity carries the identify Core generated.

POST /api/v1/client-identities

Errors

• Error::InvalidInput if identify is given for Hostname/Path, or missing for Ip/None (checked before sending).
• ErrorCode::Conflict if the IP address is already in use, by anyone.
• ErrorCode::Validation if identify is not an IP address.

Examples

use dinio_sdk::models::{ClientIdentityType, NewClientIdentity};

let new = NewClientIdentity {
    identify: None,
    id_type: ClientIdentityType::Path,
    name: Some("phone".into()),
};
let identity = client.client_identities().create(&new).await?;
println!("DoH path part: {}", identity.identify);

pub async fn update( &self, uuid: Uuid, patch: &ClientIdentityPatch, ) -> Result<ClientIdentity>

Changes an identity; fields left None stay as they are.

PATCH /api/v1/client-identities/:uuid

Errors

• ErrorCode::NotFound if there is no such identity.
• ErrorCode::Forbidden if it belongs to another user.
• ErrorCode::Suspended if the identity or its owner is suspended.
• ErrorCode::Conflict if the new identify is in use.
• ErrorCode::Validation if the result would not pair identify and id_type correctly (see ClientIdentityPatch).

pub async fn regenerate_identify(&self, uuid: Uuid) -> Result<ClientIdentity>

Replaces the generated identify of a Hostname/Path identity with a new one. The old value stops working on Relay, so every device configured with it needs the new one.

POST /api/v1/client-identities/:uuid/identify

Errors

• ErrorCode::NotFound if there is no such identity.
• ErrorCode::Forbidden if it belongs to another user.
• ErrorCode::Suspended if the identity or its owner is suspended.
• ErrorCode::Validation for an Ip/None identity, whose identify is an address, not generated.

pub async fn delete(&self, uuid: Uuid) -> Result<()>

Deletes an identity.

DELETE /api/v1/client-identities/:uuid

Errors

• ErrorCode::NotFound if there is no such identity.
• ErrorCode::Forbidden if it belongs to another user.
• ErrorCode::Conflict while sinkhole lists are linked to it; remove the links first (SinkholeLinks::delete).