Interface TenantService
-
- All Implemented Interfaces:
public interface TenantService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceTenantService.WithRawResponseA view of TenantService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract TenantService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract TenantService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
list
TenantListResponse list(String userId)
Returns a paginated list of user tenant associations.
-
list
TenantListResponse list(String userId, TenantListParams params, RequestOptions requestOptions)
-
list
TenantListResponse list(String userId, TenantListParams params)
-
list
abstract TenantListResponse list(TenantListParams params, RequestOptions requestOptions)
-
list
TenantListResponse list(TenantListParams params)
-
list
TenantListResponse list(String userId, RequestOptions requestOptions)
-
addMultiple
Unit addMultiple(String userId, TenantAddMultipleParams params)
This endpoint is used to add a user to multiple tenants in one call. A custom profile can also be supplied for each tenant. This profile will be merged with the user's main profile when sending to the user with that tenant.
-
addMultiple
Unit addMultiple(String userId, TenantAddMultipleParams params, RequestOptions requestOptions)
-
addMultiple
Unit addMultiple(TenantAddMultipleParams params)
-
addMultiple
abstract Unit addMultiple(TenantAddMultipleParams params, RequestOptions requestOptions)
-
addSingle
Unit addSingle(String tenantId, TenantAddSingleParams params)
This endpoint is used to add a single tenant.
A custom profile can also be supplied with the tenant. This profile will be merged with the user's main profile when sending to the user with that tenant.
-
addSingle
Unit addSingle(String tenantId, TenantAddSingleParams params, RequestOptions requestOptions)
-
addSingle
Unit addSingle(TenantAddSingleParams params)
-
addSingle
abstract Unit addSingle(TenantAddSingleParams params, RequestOptions requestOptions)
-
removeAll
Unit removeAll(String userId)
Removes a user from any tenants they may have been associated with.
-
removeAll
Unit removeAll(String userId, TenantRemoveAllParams params, RequestOptions requestOptions)
-
removeAll
Unit removeAll(String userId, TenantRemoveAllParams params)
-
removeAll
abstract Unit removeAll(TenantRemoveAllParams params, RequestOptions requestOptions)
-
removeAll
Unit removeAll(TenantRemoveAllParams params)
-
removeAll
Unit removeAll(String userId, RequestOptions requestOptions)
-
removeSingle
Unit removeSingle(String tenantId, TenantRemoveSingleParams params)
Removes a user from the supplied tenant.
-
removeSingle
Unit removeSingle(String tenantId, TenantRemoveSingleParams params, RequestOptions requestOptions)
-
removeSingle
Unit removeSingle(TenantRemoveSingleParams params)
-
removeSingle
abstract Unit removeSingle(TenantRemoveSingleParams params, RequestOptions requestOptions)
-
-
-
-