Struct UsersAPI

Source
pub struct UsersAPI { /* private fields */ }
Expand description

Create, edit, and disable users.

Implementations§

Source§

impl UsersAPI

Source

pub fn new() -> Self

Source

pub fn with_config(config: Configuration) -> Self

Examples found in repository?
examples/v2_users_ListUserOrganizations.rs (line 8)
6async fn main() {
7    let configuration = datadog::Configuration::new();
8    let api = UsersAPI::with_config(configuration);
9    let resp = api
10        .list_user_organizations("00000000-0000-9999-0000-000000000000".to_string())
11        .await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
More examples
Hide additional examples
examples/v2_users_GetUser.rs (line 10)
6async fn main() {
7    // there is a valid "user" in the system
8    let user_data_id = std::env::var("USER_DATA_ID").unwrap();
9    let configuration = datadog::Configuration::new();
10    let api = UsersAPI::with_config(configuration);
11    let resp = api.get_user(user_data_id.clone()).await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
examples/v2_users_DisableUser.rs (line 10)
6async fn main() {
7    // there is a valid "user" in the system
8    let user_data_id = std::env::var("USER_DATA_ID").unwrap();
9    let configuration = datadog::Configuration::new();
10    let api = UsersAPI::with_config(configuration);
11    let resp = api.disable_user(user_data_id.clone()).await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
examples/v2_users_ListUserPermissions.rs (line 10)
6async fn main() {
7    // there is a valid "user" in the system
8    let user_data_id = std::env::var("USER_DATA_ID").unwrap();
9    let configuration = datadog::Configuration::new();
10    let api = UsersAPI::with_config(configuration);
11    let resp = api.list_user_permissions(user_data_id.clone()).await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
examples/v2_users_GetInvitation.rs (line 10)
6async fn main() {
7    // the "user" has a "user_invitation"
8    let user_invitation_id = std::env::var("USER_INVITATION_ID").unwrap();
9    let configuration = datadog::Configuration::new();
10    let api = UsersAPI::with_config(configuration);
11    let resp = api.get_invitation(user_invitation_id.clone()).await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
examples/v2_users_ListUsers_4075885358.rs (line 11)
9async fn main() {
10    let configuration = datadog::Configuration::new();
11    let api = UsersAPI::with_config(configuration);
12    let response = api.list_users_with_pagination(ListUsersOptionalParams::default().page_size(2));
13    pin_mut!(response);
14    while let Some(resp) = response.next().await {
15        if let Ok(value) = resp {
16            println!("{:#?}", value);
17        } else {
18            println!("{:#?}", resp.unwrap_err());
19        }
20    }
21}
Source

pub fn with_client_and_config( config: Configuration, client: ClientWithMiddleware, ) -> Self

Source

pub async fn create_user( &self, body: UserCreateRequest, ) -> Result<UserResponse, Error<CreateUserError>>

Create a user for your organization.

Examples found in repository?
examples/v2_users_CreateUser.rs (line 18)
10async fn main() {
11    let body = UserCreateRequest::new(UserCreateData::new(
12        UserCreateAttributes::new("Example-User@datadoghq.com".to_string())
13            .name("Datadog API Client Python".to_string()),
14        UsersType::USERS,
15    ));
16    let configuration = datadog::Configuration::new();
17    let api = UsersAPI::with_config(configuration);
18    let resp = api.create_user(body).await;
19    if let Ok(value) = resp {
20        println!("{:#?}", value);
21    } else {
22        println!("{:#?}", resp.unwrap_err());
23    }
24}
Source

pub async fn create_user_with_http_info( &self, body: UserCreateRequest, ) -> Result<ResponseContent<UserResponse>, Error<CreateUserError>>

Create a user for your organization.

Source

pub async fn disable_user( &self, user_id: String, ) -> Result<(), Error<DisableUserError>>

Disable a user. Can only be used with an application key belonging to an administrator user.

Examples found in repository?
examples/v2_users_DisableUser.rs (line 11)
6async fn main() {
7    // there is a valid "user" in the system
8    let user_data_id = std::env::var("USER_DATA_ID").unwrap();
9    let configuration = datadog::Configuration::new();
10    let api = UsersAPI::with_config(configuration);
11    let resp = api.disable_user(user_data_id.clone()).await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
Source

pub async fn disable_user_with_http_info( &self, user_id: String, ) -> Result<ResponseContent<()>, Error<DisableUserError>>

Disable a user. Can only be used with an application key belonging to an administrator user.

Source

pub async fn get_invitation( &self, user_invitation_uuid: String, ) -> Result<UserInvitationResponse, Error<GetInvitationError>>

Returns a single user invitation by its UUID.

Examples found in repository?
examples/v2_users_GetInvitation.rs (line 11)
6async fn main() {
7    // the "user" has a "user_invitation"
8    let user_invitation_id = std::env::var("USER_INVITATION_ID").unwrap();
9    let configuration = datadog::Configuration::new();
10    let api = UsersAPI::with_config(configuration);
11    let resp = api.get_invitation(user_invitation_id.clone()).await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
Source

pub async fn get_invitation_with_http_info( &self, user_invitation_uuid: String, ) -> Result<ResponseContent<UserInvitationResponse>, Error<GetInvitationError>>

Returns a single user invitation by its UUID.

Source

pub async fn get_user( &self, user_id: String, ) -> Result<UserResponse, Error<GetUserError>>

Get a user in the organization specified by the user’s user_id.

Examples found in repository?
examples/v2_users_GetUser.rs (line 11)
6async fn main() {
7    // there is a valid "user" in the system
8    let user_data_id = std::env::var("USER_DATA_ID").unwrap();
9    let configuration = datadog::Configuration::new();
10    let api = UsersAPI::with_config(configuration);
11    let resp = api.get_user(user_data_id.clone()).await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
Source

pub async fn get_user_with_http_info( &self, user_id: String, ) -> Result<ResponseContent<UserResponse>, Error<GetUserError>>

Get a user in the organization specified by the user’s user_id.

Source

pub async fn list_user_organizations( &self, user_id: String, ) -> Result<UserResponse, Error<ListUserOrganizationsError>>

Get a user organization. Returns the user information and all organizations joined by this user.

Examples found in repository?
examples/v2_users_ListUserOrganizations.rs (line 10)
6async fn main() {
7    let configuration = datadog::Configuration::new();
8    let api = UsersAPI::with_config(configuration);
9    let resp = api
10        .list_user_organizations("00000000-0000-9999-0000-000000000000".to_string())
11        .await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
Source

pub async fn list_user_organizations_with_http_info( &self, user_id: String, ) -> Result<ResponseContent<UserResponse>, Error<ListUserOrganizationsError>>

Get a user organization. Returns the user information and all organizations joined by this user.

Source

pub async fn list_user_permissions( &self, user_id: String, ) -> Result<PermissionsResponse, Error<ListUserPermissionsError>>

Get a user permission set. Returns a list of the user’s permissions granted by the associated user’s roles.

Examples found in repository?
examples/v2_users_ListUserPermissions.rs (line 11)
6async fn main() {
7    // there is a valid "user" in the system
8    let user_data_id = std::env::var("USER_DATA_ID").unwrap();
9    let configuration = datadog::Configuration::new();
10    let api = UsersAPI::with_config(configuration);
11    let resp = api.list_user_permissions(user_data_id.clone()).await;
12    if let Ok(value) = resp {
13        println!("{:#?}", value);
14    } else {
15        println!("{:#?}", resp.unwrap_err());
16    }
17}
Source

pub async fn list_user_permissions_with_http_info( &self, user_id: String, ) -> Result<ResponseContent<PermissionsResponse>, Error<ListUserPermissionsError>>

Get a user permission set. Returns a list of the user’s permissions granted by the associated user’s roles.

Source

pub async fn list_users( &self, params: ListUsersOptionalParams, ) -> Result<UsersResponse, Error<ListUsersError>>

Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.

Examples found in repository?
examples/v2_users_ListUsers.rs (line 13)
7async fn main() {
8    // there is a valid "user" in the system
9    let user_data_attributes_email = std::env::var("USER_DATA_ATTRIBUTES_EMAIL").unwrap();
10    let configuration = datadog::Configuration::new();
11    let api = UsersAPI::with_config(configuration);
12    let resp = api
13        .list_users(ListUsersOptionalParams::default().filter(user_data_attributes_email.clone()))
14        .await;
15    if let Ok(value) = resp {
16        println!("{:#?}", value);
17    } else {
18        println!("{:#?}", resp.unwrap_err());
19    }
20}
Source

pub fn list_users_with_pagination( &self, params: ListUsersOptionalParams, ) -> impl Stream<Item = Result<User, Error<ListUsersError>>> + '_

Examples found in repository?
examples/v2_users_ListUsers_4075885358.rs (line 12)
9async fn main() {
10    let configuration = datadog::Configuration::new();
11    let api = UsersAPI::with_config(configuration);
12    let response = api.list_users_with_pagination(ListUsersOptionalParams::default().page_size(2));
13    pin_mut!(response);
14    while let Some(resp) = response.next().await {
15        if let Ok(value) = resp {
16            println!("{:#?}", value);
17        } else {
18            println!("{:#?}", resp.unwrap_err());
19        }
20    }
21}
Source

pub async fn list_users_with_http_info( &self, params: ListUsersOptionalParams, ) -> Result<ResponseContent<UsersResponse>, Error<ListUsersError>>

Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.

Source

pub async fn send_invitations( &self, body: UserInvitationsRequest, ) -> Result<UserInvitationsResponse, Error<SendInvitationsError>>

Sends emails to one or more users inviting them to join the organization.

Examples found in repository?
examples/v2_users_SendInvitations.rs (line 25)
13async fn main() {
14    // there is a valid "user" in the system
15    let user_data_id = std::env::var("USER_DATA_ID").unwrap();
16    let body = UserInvitationsRequest::new(vec![UserInvitationData::new(
17        UserInvitationRelationships::new(RelationshipToUser::new(RelationshipToUserData::new(
18            user_data_id.clone(),
19            UsersType::USERS,
20        ))),
21        UserInvitationsType::USER_INVITATIONS,
22    )]);
23    let configuration = datadog::Configuration::new();
24    let api = UsersAPI::with_config(configuration);
25    let resp = api.send_invitations(body).await;
26    if let Ok(value) = resp {
27        println!("{:#?}", value);
28    } else {
29        println!("{:#?}", resp.unwrap_err());
30    }
31}
Source

pub async fn send_invitations_with_http_info( &self, body: UserInvitationsRequest, ) -> Result<ResponseContent<UserInvitationsResponse>, Error<SendInvitationsError>>

Sends emails to one or more users inviting them to join the organization.

Source

pub async fn update_user( &self, user_id: String, body: UserUpdateRequest, ) -> Result<UserResponse, Error<UpdateUserError>>

Edit a user. Can only be used with an application key belonging to an administrator user.

Examples found in repository?
examples/v2_users_UpdateUser.rs (line 22)
10async fn main() {
11    // there is a valid "user" in the system
12    let user_data_id = std::env::var("USER_DATA_ID").unwrap();
13    let body = UserUpdateRequest::new(UserUpdateData::new(
14        UserUpdateAttributes::new()
15            .disabled(true)
16            .name("updated".to_string()),
17        user_data_id.clone(),
18        UsersType::USERS,
19    ));
20    let configuration = datadog::Configuration::new();
21    let api = UsersAPI::with_config(configuration);
22    let resp = api.update_user(user_data_id.clone(), body).await;
23    if let Ok(value) = resp {
24        println!("{:#?}", value);
25    } else {
26        println!("{:#?}", resp.unwrap_err());
27    }
28}
Source

pub async fn update_user_with_http_info( &self, user_id: String, body: UserUpdateRequest, ) -> Result<ResponseContent<UserResponse>, Error<UpdateUserError>>

Edit a user. Can only be used with an application key belonging to an administrator user.

Trait Implementations§

Source§

impl Clone for UsersAPI

Source§

fn clone(&self) -> UsersAPI

Returns a duplicate of the value. Read more
1.0.0 · Source§

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for UsersAPI

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for UsersAPI

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,