github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/SCIMApi.md (about) 1 # \SCIMApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateUser**](SCIMApi.md#CreateUser) | **Post** /scim/v2/Users | Create User 8 [**DeleteUser**](SCIMApi.md#DeleteUser) | **Delete** /scim/v2/Users/{id} | Delete User 9 [**GetServiceProviderConfig**](SCIMApi.md#GetServiceProviderConfig) | **Get** /scim/v2/ServiceProviderConfig | Get Service Provider Config 10 [**GetUserById**](SCIMApi.md#GetUserById) | **Get** /scim/v2/Users/{id} | Get User 11 [**ListUsers**](SCIMApi.md#ListUsers) | **Get** /scim/v2/Users | Get User List 12 [**PatchUser**](SCIMApi.md#PatchUser) | **Patch** /scim/v2/Users/{id} | Partially update/patch a user 13 [**SearchUsersViaPost**](SCIMApi.md#SearchUsersViaPost) | **Post** /scim/v2/Users/.search | search or list users 14 [**UpdateUser**](SCIMApi.md#UpdateUser) | **Put** /scim/v2/Users/{id} | Update or replace user 15 16 17 # **CreateUser** 18 > UserInfo CreateUser(ctx, userCreationRequest) 19 Create User 20 21 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Creates a user.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 22 23 ### Required Parameters 24 25 Name | Type | Description | Notes 26 ------------- | ------------- | ------------- | ------------- 27 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 28 **userCreationRequest** | [**UserCreationRequest**](UserCreationRequest.md)| a new user without 'id' | 29 30 ### Return type 31 32 [**UserInfo**](UserInfo.md) 33 34 ### Authorization 35 36 [OAuth2](../README.md#OAuth2) 37 38 ### HTTP request headers 39 40 - **Content-Type**: application/json, application/scim+json 41 - **Accept**: application/json, application/scim+json 42 43 [[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) 44 45 # **DeleteUser** 46 > DeleteUser(ctx, id) 47 Delete User 48 49 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Deleting User using scim</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 50 51 ### Required Parameters 52 53 Name | Type | Description | Notes 54 ------------- | ------------- | ------------- | ------------- 55 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 56 **id** | **string**| Internal identifier of a user | 57 58 ### Return type 59 60 (empty response body) 61 62 ### Authorization 63 64 [OAuth2](../README.md#OAuth2) 65 66 ### HTTP request headers 67 68 - **Content-Type**: Not defined 69 - **Accept**: application/json, application/scim+json 70 71 [[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) 72 73 # **GetServiceProviderConfig** 74 > ServiceProviderConfig GetServiceProviderConfig(ctx, ) 75 Get Service Provider Config 76 77 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns the list of users requested.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing Service Provider confiog</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 78 79 ### Required Parameters 80 This endpoint does not need any parameter. 81 82 ### Return type 83 84 [**ServiceProviderConfig**](ServiceProviderConfig.md) 85 86 ### Authorization 87 88 [OAuth2](../README.md#OAuth2) 89 90 ### HTTP request headers 91 92 - **Content-Type**: Not defined 93 - **Accept**: application/json, application/scim+json 94 95 [[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) 96 97 # **GetUserById** 98 > UserInfo GetUserById(ctx, id) 99 Get User 100 101 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a user by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 102 103 ### Required Parameters 104 105 Name | Type | Description | Notes 106 ------------- | ------------- | ------------- | ------------- 107 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 108 **id** | **string**| Internal identifier of a user | 109 110 ### Return type 111 112 [**UserInfo**](UserInfo.md) 113 114 ### Authorization 115 116 [OAuth2](../README.md#OAuth2) 117 118 ### HTTP request headers 119 120 - **Content-Type**: Not defined 121 - **Accept**: application/json, application/scim+json 122 123 [[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) 124 125 # **ListUsers** 126 > GetUserListResponse ListUsers(ctx, optional) 127 Get User List 128 129 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns the list of users requested.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 130 131 ### Required Parameters 132 133 Name | Type | Description | Notes 134 ------------- | ------------- | ------------- | ------------- 135 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 136 **optional** | ***ListUsersOpts** | optional parameters | nil if no parameters 137 138 ### Optional Parameters 139 Optional parameters are passed through a pointer to a ListUsersOpts struct 140 141 Name | Type | Description | Notes 142 ------------- | ------------- | ------------- | ------------- 143 **filter** | **optional.String**| only support 'userName' or 'email' filter expressions for now | 144 **count** | **optional.Int32**| page size | [default to 100] 145 **startIndex** | **optional.Int32**| start index (1-based) | [default to 1] 146 147 ### Return type 148 149 [**GetUserListResponse**](GetUserListResponse.md) 150 151 ### Authorization 152 153 [OAuth2](../README.md#OAuth2) 154 155 ### HTTP request headers 156 157 - **Content-Type**: Not defined 158 - **Accept**: application/json, application/scim+json 159 160 [[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) 161 162 # **PatchUser** 163 > UserInfo PatchUser(ctx, id, optional) 164 Partially update/patch a user 165 166 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Partially update/patch a user</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 167 168 ### Required Parameters 169 170 Name | Type | Description | Notes 171 ------------- | ------------- | ------------- | ------------- 172 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 173 **id** | **string**| Internal identifier of a user | 174 **optional** | ***PatchUserOpts** | optional parameters | nil if no parameters 175 176 ### Optional Parameters 177 Optional parameters are passed through a pointer to a PatchUserOpts struct 178 179 Name | Type | Description | Notes 180 ------------- | ------------- | ------------- | ------------- 181 182 **scimUserPatch** | [**optional.Interface of ScimUserPatch**](ScimUserPatch.md)| patch operations list | 183 184 ### Return type 185 186 [**UserInfo**](UserInfo.md) 187 188 ### Authorization 189 190 [OAuth2](../README.md#OAuth2) 191 192 ### HTTP request headers 193 194 - **Content-Type**: application/json, application/scim+json 195 - **Accept**: application/json, application/scim+json 196 197 [[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) 198 199 # **SearchUsersViaPost** 200 > GetUserListResponse SearchUsersViaPost(ctx, optional) 201 search or list users 202 203 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns the list of users requested.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Searching SCIM Users</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 204 205 ### Required Parameters 206 207 Name | Type | Description | Notes 208 ------------- | ------------- | ------------- | ------------- 209 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 210 **optional** | ***SearchUsersViaPostOpts** | optional parameters | nil if no parameters 211 212 ### Optional Parameters 213 Optional parameters are passed through a pointer to a SearchUsersViaPostOpts struct 214 215 Name | Type | Description | Notes 216 ------------- | ------------- | ------------- | ------------- 217 **scimSearchRequestInfo** | [**optional.Interface of ScimSearchRequestInfo**](ScimSearchRequestInfo.md)| search parameters | 218 219 ### Return type 220 221 [**GetUserListResponse**](GetUserListResponse.md) 222 223 ### Authorization 224 225 [OAuth2](../README.md#OAuth2) 226 227 ### HTTP request headers 228 229 - **Content-Type**: application/json, application/scim+json 230 - **Accept**: application/json, application/scim+json 231 232 [[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) 233 234 # **UpdateUser** 235 > UserInfo UpdateUser(ctx, id, userUpdateRequest) 236 Update or replace user 237 238 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Updating User using SCIM</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 239 240 ### Required Parameters 241 242 Name | Type | Description | Notes 243 ------------- | ------------- | ------------- | ------------- 244 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 245 **id** | **string**| Internal identifier of a user | 246 **userUpdateRequest** | [**UserUpdateRequest**](UserUpdateRequest.md)| An Exisiting User | 247 248 ### Return type 249 250 [**UserInfo**](UserInfo.md) 251 252 ### Authorization 253 254 [OAuth2](../README.md#OAuth2) 255 256 ### HTTP request headers 257 258 - **Content-Type**: application/json, application/scim+json 259 - **Accept**: application/json, application/scim+json 260 261 [[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) 262