workos 0.8.1

Rust SDK for interacting with the WorkOS API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use async_trait::async_trait;
use thiserror::Error;

use crate::organizations::{Organization, OrganizationId, Organizations};
use crate::{ResponseExt, WorkOsError, WorkOsResult};

/// An error returned from [`GetOrganization`].
#[derive(Debug, Error)]
pub enum GetOrganizationError {}

impl From<GetOrganizationError> for WorkOsError<GetOrganizationError> {
    fn from(err: GetOrganizationError) -> Self {
        Self::Operation(err)
    }
}

/// [WorkOS Docs: Get an Organization](https://workos.com/docs/reference/organization/get)
#[async_trait]
pub trait GetOrganization {
    /// Get the details of an existing organization.
    ///
    /// [WorkOS Docs: Get an Organization](https://workos.com/docs/reference/organization/get)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::organizations::*;
    /// use workos::{ApiKey, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), GetOrganizationError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let organization = workos
    ///     .organizations()
    ///     .get_organization(&OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT"))
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn get_organization(
        &self,
        id: &OrganizationId,
    ) -> WorkOsResult<Organization, GetOrganizationError>;
}

#[async_trait]
impl GetOrganization for Organizations<'_> {
    async fn get_organization(
        &self,
        id: &OrganizationId,
    ) -> WorkOsResult<Organization, GetOrganizationError> {
        let url = self
            .workos
            .base_url()
            .join(&format!("/organizations/{id}"))?;

        let organization = self
            .workos
            .client()
            .get(url)
            .bearer_auth(self.workos.key())
            .send()
            .await?
            .handle_unauthorized_or_generic_error()
            .await?
            .json::<Organization>()
            .await?;

        Ok(organization)
    }
}

#[cfg(test)]
mod test {
    use serde_json::json;
    use tokio;

    use crate::{ApiKey, WorkOs};

    use super::*;

    #[tokio::test]
    async fn it_calls_the_get_organization_endpoint() {
        let mut server = mockito::Server::new_async().await;

        let workos = WorkOs::builder(&ApiKey::from("sk_example_123456789"))
            .base_url(&server.url())
            .unwrap()
            .build();

        server
            .mock("GET", "/organizations/org_01EHZNVPK3SFK441A1RGBFSHRT")
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(200)
            .with_body(
                json!({
                  "id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                  "object": "organization",
                  "name": "Foo Corporation",
                  "allow_profiles_outside_organization": false,
                  "created_at": "2021-06-25T19:07:33.155Z",
                  "updated_at": "2021-06-25T19:07:33.155Z",
                  "domains": [
                     {
                        "object": "organization_domain",
                        "id": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A",
                        "domain": "foo-corp.com",
                        "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                        "state": "verified",
                        "verification_strategy": "dns",
                        "verification_token": "m5Oztg3jdK4NJLgs8uIlIprMw",
                        "created_at": "2021-06-25T19:07:33.155Z",
                        "updated_at": "2021-06-25T19:07:33.155Z"
                    },
                    {
                        "object": "organization_domain",
                        "id": "org_domain_01EHZNS0H9W90A90FV79GAB6AB",
                        "domain": "another-foo-corp-domain.com",
                        "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                        "state": "verified",
                        "verification_strategy": "dns",
                        "verification_token": "m5Oztg3jdK4NJLgs8uIlIprMw",
                        "created_at": "2021-06-25T19:07:33.155Z",
                        "updated_at": "2021-06-25T19:07:33.155Z"
                    }
                  ]
                })
                .to_string(),
            )
            .create_async()
            .await;

        let organization = workos
            .organizations()
            .get_organization(&OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT"))
            .await
            .unwrap();

        assert_eq!(
            organization.id,
            OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT")
        )
    }
}