sideko_rest_api 0.9.2

Rust API Client
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

# user

## Module Functions

### Invite User <a name="invite"></a>

Invite a user to an organization with a specific role

**API Endpoint**: `POST /user/invite`

#### Parameters

| Parameter            | Required | Description | Example                                 |
| -------------------- | :------: | ----------- | --------------------------------------- |
| `email`              |    ✓     |             | `"user@example.com".to_string()`        |
| `role_definition_id` |    ✓     |             | `RoleDefinitionIdEnum::ApiProjectAdmin` |

#### Example Snippet

```rust
let client = sideko_rest_api::SidekoClient::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());
let res = client
    .user()
    .invite(sideko_rest_api::resources::user::InviteRequest {
        email: "user@example.com".to_string(),
        role_definition_id: sideko_rest_api::models::RoleDefinitionIdEnum::ApiProjectAdmin,
    })
    .await;
```

## Submodules

- [me](me/README.md) - me