pub struct UsersAPI { /* private fields */ }
Expand description
Create, edit, and disable users.
Implementations§
Source§impl UsersAPI
impl UsersAPI
pub fn new() -> Self
Sourcepub fn with_config(config: Configuration) -> Self
pub fn with_config(config: Configuration) -> Self
Examples found in repository?
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
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}
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}
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}
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}
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}
pub fn with_client_and_config( config: Configuration, client: ClientWithMiddleware, ) -> Self
Sourcepub async fn create_user(
&self,
body: UserCreateRequest,
) -> Result<UserResponse, Error<CreateUserError>>
pub async fn create_user( &self, body: UserCreateRequest, ) -> Result<UserResponse, Error<CreateUserError>>
Create a user for your organization.
Examples found in repository?
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}
Sourcepub async fn create_user_with_http_info(
&self,
body: UserCreateRequest,
) -> Result<ResponseContent<UserResponse>, Error<CreateUserError>>
pub async fn create_user_with_http_info( &self, body: UserCreateRequest, ) -> Result<ResponseContent<UserResponse>, Error<CreateUserError>>
Create a user for your organization.
Sourcepub async fn disable_user(
&self,
user_id: String,
) -> Result<(), Error<DisableUserError>>
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?
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}
Sourcepub async fn disable_user_with_http_info(
&self,
user_id: String,
) -> Result<ResponseContent<()>, Error<DisableUserError>>
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.
Sourcepub async fn get_invitation(
&self,
user_invitation_uuid: String,
) -> Result<UserInvitationResponse, Error<GetInvitationError>>
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?
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}
Sourcepub async fn get_invitation_with_http_info(
&self,
user_invitation_uuid: String,
) -> Result<ResponseContent<UserInvitationResponse>, Error<GetInvitationError>>
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.
Sourcepub async fn get_user(
&self,
user_id: String,
) -> Result<UserResponse, Error<GetUserError>>
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?
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}
Sourcepub async fn get_user_with_http_info(
&self,
user_id: String,
) -> Result<ResponseContent<UserResponse>, Error<GetUserError>>
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
.
Sourcepub async fn list_user_organizations(
&self,
user_id: String,
) -> Result<UserResponse, Error<ListUserOrganizationsError>>
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?
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}
Sourcepub async fn list_user_organizations_with_http_info(
&self,
user_id: String,
) -> Result<ResponseContent<UserResponse>, Error<ListUserOrganizationsError>>
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.
Sourcepub async fn list_user_permissions(
&self,
user_id: String,
) -> Result<PermissionsResponse, Error<ListUserPermissionsError>>
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?
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}
Sourcepub async fn list_user_permissions_with_http_info(
&self,
user_id: String,
) -> Result<ResponseContent<PermissionsResponse>, Error<ListUserPermissionsError>>
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.
Sourcepub async fn list_users(
&self,
params: ListUsersOptionalParams,
) -> Result<UsersResponse, Error<ListUsersError>>
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?
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}
Sourcepub fn list_users_with_pagination(
&self,
params: ListUsersOptionalParams,
) -> impl Stream<Item = Result<User, Error<ListUsersError>>> + '_
pub fn list_users_with_pagination( &self, params: ListUsersOptionalParams, ) -> impl Stream<Item = Result<User, Error<ListUsersError>>> + '_
Examples found in repository?
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}
Sourcepub async fn list_users_with_http_info(
&self,
params: ListUsersOptionalParams,
) -> Result<ResponseContent<UsersResponse>, Error<ListUsersError>>
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.
Sourcepub async fn send_invitations(
&self,
body: UserInvitationsRequest,
) -> Result<UserInvitationsResponse, Error<SendInvitationsError>>
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?
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}
Sourcepub async fn send_invitations_with_http_info(
&self,
body: UserInvitationsRequest,
) -> Result<ResponseContent<UserInvitationsResponse>, Error<SendInvitationsError>>
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.
Sourcepub async fn update_user(
&self,
user_id: String,
body: UserUpdateRequest,
) -> Result<UserResponse, Error<UpdateUserError>>
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?
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}
Sourcepub async fn update_user_with_http_info(
&self,
user_id: String,
body: UserUpdateRequest,
) -> Result<ResponseContent<UserResponse>, Error<UpdateUserError>>
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.