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

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

use crate::sso::{AccessToken, Profile, Sso};
use crate::{ResponseExt, WorkOsResult};

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

/// [WorkOS Docs: Get a User Profile](https://workos.com/docs/reference/sso/profile/user)
#[async_trait]
pub trait GetProfile {
    /// [WorkOS Docs: Get a User Profile](https://workos.com/docs/reference/sso/profile/user)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::sso::*;
    /// use workos::{ApiKey, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), GetProfileError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let profile = workos
    ///     .sso()
    ///     .get_profile(&AccessToken::from("01DMEK0J53CVMC32CK5SE0KZ8Q"))
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn get_profile(
        &self,
        access_token: &AccessToken,
    ) -> WorkOsResult<Profile, GetProfileError>;
}

#[async_trait]
impl GetProfile for Sso<'_> {
    async fn get_profile(
        &self,
        access_token: &AccessToken,
    ) -> WorkOsResult<Profile, GetProfileError> {
        let url = self.workos.base_url().join("/sso/profile")?;
        let get_profile_response = self
            .workos
            .client()
            .get(url)
            .bearer_auth(access_token)
            .send()
            .await?
            .handle_unauthorized_or_generic_error()
            .await?
            .json::<Profile>()
            .await?;

        Ok(get_profile_response)
    }
}

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

    use crate::sso::ProfileId;
    use crate::{ApiKey, WorkOs};

    use super::*;

    #[tokio::test]
    async fn it_calls_the_get_profile_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", "/sso/profile")
            .match_header("Authorization", "Bearer 01DMEK0J53CVMC32CK5SE0KZ8Q")
            .with_status(200)
            .with_body(
                json!({
                  "id": "prof_01DMC79VCBZ0NY2099737PSVF1",
                  "connection_id": "conn_01E4ZCR3C56J083X43JQXF3JK5",
                  "connection_type": "okta",
                  "email": "todd@foo-corp.com",
                  "first_name": "Todd",
                  "idp_id": "00u1a0ufowBJlzPlk357",
                  "last_name": "Rundgren",
                  "object": "profile"
                })
                .to_string(),
            )
            .create_async()
            .await;

        let profile = workos
            .sso()
            .get_profile(&AccessToken::from("01DMEK0J53CVMC32CK5SE0KZ8Q"))
            .await
            .unwrap();

        assert_eq!(
            profile.id,
            ProfileId::from("prof_01DMC79VCBZ0NY2099737PSVF1")
        )
    }
}