Struct datadog_api_client::datadogV2::api::api_restriction_policies::RestrictionPoliciesAPI

pub struct RestrictionPoliciesAPI { /* private fields */ }

A restriction policy defines the access control rules for a resource, mapping a set of relations (such as editor and viewer) to a set of allowed principals (such as roles, teams, or users). The restriction policy determines who is authorized to perform what actions on the resource.

Implementations

impl RestrictionPoliciesAPI

pub fn new() -> Self

pub fn with_config(config: Configuration) -> Self

Examples found in repository

examples/v2_restriction-policies_GetRestrictionPolicy.rs (line 8)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = RestrictionPoliciesAPI::with_config(configuration);
    let resp = api
        .get_restriction_policy("dashboard:test-get".to_string())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v2_restriction-policies_DeleteRestrictionPolicy.rs (line 8)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = RestrictionPoliciesAPI::with_config(configuration);
    let resp = api
        .delete_restriction_policy("dashboard:test-delete".to_string())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v2_restriction-policies_UpdateRestrictionPolicy.rs (line 22)

async fn main() {
    // there is a valid "user" in the system
    let body = RestrictionPolicyUpdateRequest::new(RestrictionPolicy::new(
        RestrictionPolicyAttributes::new(vec![RestrictionPolicyBinding::new(
            vec!["org:00000000-0000-beef-0000-000000000000".to_string()],
            "editor".to_string(),
        )]),
        "dashboard:test-update".to_string(),
        RestrictionPolicyType::RESTRICTION_POLICY,
    ));
    let configuration = datadog::Configuration::new();
    let api = RestrictionPoliciesAPI::with_config(configuration);
    let resp = api
        .update_restriction_policy("dashboard:test-update".to_string(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

pub async fn delete_restriction_policy( &self, resource_id: String, ) -> Result<(), Error<DeleteRestrictionPolicyError>>

Deletes the restriction policy associated with a specified resource.

Examples found in repository

examples/v2_restriction-policies_DeleteRestrictionPolicy.rs (line 10)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = RestrictionPoliciesAPI::with_config(configuration);
    let resp = api
        .delete_restriction_policy("dashboard:test-delete".to_string())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub async fn delete_restriction_policy_with_http_info( &self, resource_id: String, ) -> Result<ResponseContent<()>, Error<DeleteRestrictionPolicyError>>

Deletes the restriction policy associated with a specified resource.

pub async fn get_restriction_policy( &self, resource_id: String, ) -> Result<RestrictionPolicyResponse, Error<GetRestrictionPolicyError>>

Retrieves the restriction policy associated with a specified resource.

Examples found in repository

examples/v2_restriction-policies_GetRestrictionPolicy.rs (line 10)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = RestrictionPoliciesAPI::with_config(configuration);
    let resp = api
        .get_restriction_policy("dashboard:test-get".to_string())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub async fn get_restriction_policy_with_http_info( &self, resource_id: String, ) -> Result<ResponseContent<RestrictionPolicyResponse>, Error<GetRestrictionPolicyError>>

Retrieves the restriction policy associated with a specified resource.

pub async fn update_restriction_policy( &self, resource_id: String, body: RestrictionPolicyUpdateRequest, ) -> Result<RestrictionPolicyResponse, Error<UpdateRestrictionPolicyError>>

Updates the restriction policy associated with a resource.

Supported resources

Restriction policies can be applied to the following resources:

• Dashboards: dashboard
• Notebooks: notebook
• Powerpacks: powerpack
• Security Rules: security-rule
• Service Level Objectives: slo
• Synthetic Global Variables: synthetics-global-variable
• Synthetic Tests: synthetics-test
• Synthetic Private Locations: synthetics-private-location
• Monitors: monitor

Supported relations for resources

Resource Type	Supported Relations
Dashboards	viewer, editor
Notebooks	viewer, editor
Powerpacks	viewer, editor
Security Rules	viewer, editor
Service Level Objectives	viewer, editor
Synthetic Global Variables	viewer, editor
Synthetic Tests	viewer, editor
Synthetic Private Locations	viewer, editor
Monitors	viewer, editor

Examples found in repository

examples/v2_restriction-policies_UpdateRestrictionPolicy.rs (line 24)

async fn main() {
    // there is a valid "user" in the system
    let body = RestrictionPolicyUpdateRequest::new(RestrictionPolicy::new(
        RestrictionPolicyAttributes::new(vec![RestrictionPolicyBinding::new(
            vec!["org:00000000-0000-beef-0000-000000000000".to_string()],
            "editor".to_string(),
        )]),
        "dashboard:test-update".to_string(),
        RestrictionPolicyType::RESTRICTION_POLICY,
    ));
    let configuration = datadog::Configuration::new();
    let api = RestrictionPoliciesAPI::with_config(configuration);
    let resp = api
        .update_restriction_policy("dashboard:test-update".to_string(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub async fn update_restriction_policy_with_http_info( &self, resource_id: String, body: RestrictionPolicyUpdateRequest, ) -> Result<ResponseContent<RestrictionPolicyResponse>, Error<UpdateRestrictionPolicyError>>

Updates the restriction policy associated with a resource.

Supported resources

Restriction policies can be applied to the following resources:

• Dashboards: dashboard
• Notebooks: notebook
• Powerpacks: powerpack
• Security Rules: security-rule
• Service Level Objectives: slo
• Synthetic Global Variables: synthetics-global-variable
• Synthetic Tests: synthetics-test
• Synthetic Private Locations: synthetics-private-location
• Monitors: monitor

Supported relations for resources

Resource Type	Supported Relations
Dashboards	viewer, editor
Notebooks	viewer, editor
Powerpacks	viewer, editor
Security Rules	viewer, editor
Service Level Objectives	viewer, editor
Synthetic Global Variables	viewer, editor
Synthetic Tests	viewer, editor
Synthetic Private Locations	viewer, editor
Monitors	viewer, editor

Trait Implementations

impl Clone for RestrictionPoliciesAPI

fn clone(&self) -> RestrictionPoliciesAPI

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RestrictionPoliciesAPI

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

Formats the value using the given formatter.

impl Default for RestrictionPoliciesAPI

fn default() -> Self

Returns the “default value” for a type.