pipedrive-rs 0.1.0

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

# \PermissionSetsApi

All URIs are relative to *https://api.pipedrive.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_permission_set**](PermissionSetsApi.md#get_permission_set) | **GET** /permissionSets/{id} | Get one permission set
[**get_permission_set_assignments**](PermissionSetsApi.md#get_permission_set_assignments) | **GET** /permissionSets/{id}/assignments | List permission set assignments
[**get_permission_sets**](PermissionSetsApi.md#get_permission_sets) | **GET** /permissionSets | Get all permission sets



## get_permission_set

> crate::models::SinglePermissionSetResponse200 get_permission_set(id)
Get one permission set

Returns data about a specific permission set.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The ID of the permission set | [required] |

### Return type

[**crate::models::SinglePermissionSetResponse200**](singlePermissionSetResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_permission_set_assignments

> crate::models::UserAssignmentsToPermissionSetResponse200 get_permission_set_assignments(id, start, limit)
List permission set assignments

Returns the list of assignments for a permission set.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The ID of the permission set | [required] |
**start** | Option<**i32**> | Pagination start |  |[default to 0]
**limit** | Option<**i32**> | Items shown per page |  |

### Return type

[**crate::models::UserAssignmentsToPermissionSetResponse200**](userAssignmentsToPermissionSetResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_permission_sets

> crate::models::GetPermissionSetsResponse200 get_permission_sets(app)
Get all permission sets

Returns data about all permission sets.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app** | Option<**String**> | The app to filter the permission sets by |  |

### Return type

[**crate::models::GetPermissionSetsResponse200**](getPermissionSetsResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)