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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
use async_trait::async_trait;
use serde::Serialize;
use thiserror::Error;
use crate::user_management::{PasswordParams, User, UserManagement};
use crate::{Metadata, ResponseExt, WorkOsError, WorkOsResult};
/// The parameters for [`CreateUser`].
#[derive(Debug, Serialize)]
pub struct CreateUserParams<'a> {
/// The email address of the user.
pub email: &'a str,
/// The password to set for the user.
#[serde(flatten)]
pub password: Option<&'a PasswordParams<'a>>,
/// The first name of the user.
pub first_name: Option<&'a str>,
/// The last name of the user.
pub last_name: Option<&'a str>,
/// Whether the user's email address was previously verified.
pub email_verified: Option<bool>,
/// The external ID of the user.
pub external_id: Option<&'a str>,
/// Object containing metadata key/value pairs associated with the user.
pub metadata: Option<Metadata>,
}
/// An error returned from [`CreateUser`].
#[derive(Debug, Error)]
pub enum CreateUserError {}
impl From<CreateUserError> for WorkOsError<CreateUserError> {
fn from(err: CreateUserError) -> Self {
Self::Operation(err)
}
}
/// [WorkOS Docs: Create an User](https://workos.com/docs/reference/user-management/user/create)
#[async_trait]
pub trait CreateUser {
/// Create a new user in the current environment.
///
/// [WorkOS Docs: Create an User](https://workos.com/docs/reference/user-management/user/create)
///
/// # Examples
///
/// ```
/// # use workos::WorkOsResult;
/// # use workos::user_management::*;
/// use workos::{ApiKey, WorkOs};
///
/// # async fn run() -> WorkOsResult<(), CreateUserError> {
/// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
///
/// let user = workos
/// .user_management()
/// .create_user(&CreateUserParams {
/// email: "marcelina@example.com",
/// password: Some(&PasswordParams::Password {
/// password: "i8uv6g34kd490s",
/// }),
/// first_name: Some("Marcelina"),
/// last_name: Some("Davis"),
/// email_verified: Some(false),
/// external_id: None,
/// metadata: None,
/// })
/// .await?;
/// # Ok(())
/// # }
/// ```
async fn create_user(
&self,
params: &CreateUserParams<'_>,
) -> WorkOsResult<User, CreateUserError>;
}
#[async_trait]
impl CreateUser for UserManagement<'_> {
async fn create_user(
&self,
params: &CreateUserParams<'_>,
) -> WorkOsResult<User, CreateUserError> {
let url = self.workos.base_url().join("/user_management/users")?;
let user = self
.workos
.client()
.post(url)
.bearer_auth(self.workos.key())
.json(¶ms)
.send()
.await?
.handle_unauthorized_or_generic_error()
.await?
.json::<User>()
.await?;
Ok(user)
}
}
#[cfg(test)]
mod test {
use serde_json::json;
use tokio;
use crate::user_management::UserId;
use crate::{ApiKey, WorkOs};
use super::*;
#[tokio::test]
async fn it_calls_the_create_user_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("POST", "/user_management/users")
.match_header("Authorization", "Bearer sk_example_123456789")
.with_status(201)
.with_body(
json!({
"object": "user",
"id": "user_01E4ZCR3C56J083X43JQXF3JK5",
"email": "marcelina.davis@example.com",
"first_name": "Marcelina",
"last_name": "Davis",
"email_verified": true,
"profile_picture_url": "https://workoscdn.com/images/v1/123abc",
"last_sign_in_at": "2021-06-25T19:07:33.155Z",
"created_at": "2021-06-25T19:07:33.155Z",
"updated_at": "2021-06-25T19:07:33.155Z"
})
.to_string(),
)
.create_async()
.await;
let user = workos
.user_management()
.create_user(&CreateUserParams {
email: "marcelina@example.com",
password: Some(&PasswordParams::Password {
password: "i8uv6g34kd490s",
}),
first_name: Some("Marcelina"),
last_name: Some("Davis"),
email_verified: Some(false),
external_id: None,
metadata: None,
})
.await
.unwrap();
assert_eq!(user.id, UserId::from("user_01E4ZCR3C56J083X43JQXF3JK5"))
}
}