Package com.ringcentral.paths.scim.users

Class Index

java.lang.Object

com.ringcentral.paths.scim.users.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	scimUserId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String scimUserId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes a user HTTP Method: delete Endpoint: /scim/{version}/Users/{scimUserId} Rate Limit Group: Heavy App Permission: EditAccounts
Index	dotSearch()
ScimUserResponse	get()	Returns a user by ID HTTP Method: get Endpoint: /scim/{version}/Users/{scimUserId} Rate Limit Group: Light App Permission: ReadAccounts
ScimUserSearchResponse	list()
ScimUserSearchResponse	list(ScimSearchViaGet2Parameters queryParams)	Returns the list of users satisfying search criteria HTTP Method: get Endpoint: /scim/{version}/Users Rate Limit Group: Light App Permission: ReadAccounts
ScimUserResponse	patch(ScimUserPatch scimUserPatch)	Updates a user (partial update) HTTP Method: patch Endpoint: /scim/{version}/Users/{scimUserId} Rate Limit Group: Heavy App Permission: EditAccounts
String	path()
String	path(Boolean withParameter)
ScimUserResponse	post(ScimUser scimUser)	Creates a new user HTTP Method: post Endpoint: /scim/{version}/Users Rate Limit Group: Heavy App Permission: EditAccounts
ScimUserResponse	put(ScimUser scimUser)	Updates a user HTTP Method: put Endpoint: /scim/{version}/Users/{scimUserId} Rate Limit Group: Heavy App Permission: EditAccounts

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rc

public RestClient rc

parent

public Index parent

scimUserId

public String scimUserId

Constructor Details

Index

public Index(Index parent,
 String scimUserId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public ScimUserSearchResponse list(ScimSearchViaGet2Parameters queryParams)
                            throws RestException,
IOException

Returns the list of users satisfying search criteria HTTP Method: get Endpoint: /scim/{version}/Users Rate Limit Group: Light App Permission: ReadAccounts

Throws:

RestException

IOException

list

public ScimUserSearchResponse list()
                            throws RestException,
IOException

Throws:

RestException

IOException

post

public ScimUserResponse post(ScimUser scimUser)
                      throws RestException,
IOException

Creates a new user HTTP Method: post Endpoint: /scim/{version}/Users Rate Limit Group: Heavy App Permission: EditAccounts

Throws:

RestException

IOException

get

public ScimUserResponse get()
                     throws RestException,
IOException

Returns a user by ID HTTP Method: get Endpoint: /scim/{version}/Users/{scimUserId} Rate Limit Group: Light App Permission: ReadAccounts

Throws:

RestException

IOException

put

public ScimUserResponse put(ScimUser scimUser)
                     throws RestException,
IOException

Updates a user HTTP Method: put Endpoint: /scim/{version}/Users/{scimUserId} Rate Limit Group: Heavy App Permission: EditAccounts

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes a user HTTP Method: delete Endpoint: /scim/{version}/Users/{scimUserId} Rate Limit Group: Heavy App Permission: EditAccounts

Throws:

RestException

IOException

patch

public ScimUserResponse patch(ScimUserPatch scimUserPatch)
                       throws RestException,
IOException

Updates a user (partial update) HTTP Method: patch Endpoint: /scim/{version}/Users/{scimUserId} Rate Limit Group: Heavy App Permission: EditAccounts

Throws:

RestException

IOException

dotSearch

public Index dotSearch()