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
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

# Groups
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_group**](#create_group) | **POST** /v1/groups | Create group
[**delete_group**](#delete_group) | **DELETE** /v1/groups/{groupId} | Deletes group
[**get_group**](#get_group) | **GET** /v1/groups/{groupId} | Retrieve group
[**get_groups**](#get_groups) | **GET** /v1/groups | List groups
[**update_group**](#update_group) | **PUT** /v1/groups/{groupId} | Update a group



## create_group

> crate::models::Group create_group(group)
Create group

Specify users to be included in a new group. (Groups have a maximum size of ~100KB)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group** | [**Group**](Group.md) |  | [required] |

### Return type

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

---


## delete_group

> delete_group(group_id)
Deletes group

Remove a group, users will lose any role that was assigned through membership of this group. This action cannot be undone.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | The identifier of the group. | [required] |

### Return type

 (empty response body)


---


## get_group

> crate::models::Group get_group(group_id)
Retrieve group

A group contains multiple users which can be added to an access record, and should be assigned the same roles at the same time.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | The identifier of the group. | [required] |

### Return type

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


---


## get_groups

> crate::models::GroupCollection get_groups(limit, cursor, filter)
List groups

Returns a paginated groups list for the account. Only groups the user has access to are returned. This query resource is meant for administrative actions only, therefore has a lower rate limit tier than user permissions related resources.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Max number of results to return |  |[default to 20]
**cursor** | Option<**String**> | Continuation cursor for paging |  |
**filter** | Option<**String**> | Filter to search groups by. This is a case insensitive search through every text field. |  |

### Return type

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


---


## update_group

> crate::models::Group update_group(group_id, group, { expected_last_modified_time })
Update a group

Updates a group adding or removing user. Change a group updates the permissions and roles the users have access to. (Groups have a maximum size of ~100KB)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** | The identifier of the group. | [required] |
**group** | [**Group**](Group.md) |  | [required] |
**expected_last_modified_time** | Option<**DateTime**> | The expected last time the group was modified. |  |

### Return type

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

---