authress 0.1.66

The Authress SDK for RUST - provides authorization as a service with fully compatible REST apis. Authentication / Authorization / User Identity Roles / Permissions / Policies
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

# Users
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_user**](#delete_user) | **DELETE** /v1/users/{userId} | Delete a user
[**get_user**](#get_user) | **GET** /v1/users/{userId} | Retrieve a user
[**get_users**](#get_users) | **GET** /v1/users | List users



## delete_user

> delete_user(user_id)
Delete a user

Removes the user, all access the user has been granted through Authress access records, and any related user data. This action is completed asynchronously.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | The user identifier. | [required] |

### Return type

 (empty response body)


---


## get_user

> crate::models::UserIdentity get_user(user_id)
Retrieve a user

Get the user data associated with a user. The data returned by this endpoint is highly variable based on the source OAuth provider. Avoid depending on undocumented properties.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | The user identifier. | [required] |

### Return type

[**crate::models::UserIdentity**](UserIdentity.md)


---


## get_users

> crate::models::UserIdentityCollection get_users(limit, cursor, filter, tenant_id)
List users

Returns a paginated user list for the account. The data returned by this endpoint is highly variable based on the source OAuth provider. Avoid depending on undocumented properties.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Max number of results to return |  |[default to 100]
**cursor** | Option<**String**> | Continuation cursor for paging |  |
**filter** | Option<**String**> | Filter to search users by. This is a case insensitive search through every text field. |  |
**tenant_id** | Option<**String**> | Return only users that are part of the specified tenant. Users can only be part of one tenant, using this parameter will limit returned users that have logged into this tenant. |  |

### Return type

[**crate::models::UserIdentityCollection**](UserIdentityCollection.md)


---