UsersApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| usersAddWeatherNotifications | POST /{tenantId}/directory/{directoryId}/users/{userId}/notifications/weather | |
| usersCreate | POST /{tenantId}/directory/{directoryId}/users | Create a new UserProfile in the targeted Tenant and Directory |
| usersCreateEmailVerificationNonce | POST /{tenantId}/directory/{directoryId}/users/{userId}/contact/emails/{emailAddress}/verification/nonce | Reserve a client generated Nonce to trigger the Verification Code process. Returns 429 if too many requests have been requested in the allowed time. |
| usersCreateExternalId | POST /{tenantId}/directory/{directoryId}/users/{userId}/externalId | Associate a new ExternalId to an existing user that belongs to a specific Tenant and Directory by the User's Identifier. |
| usersCreateGroupMembership | POST /{tenantId}/directory/{directoryId}/users/{userId}/notifications/memberships | Add the targeted UserProfile as a member of the targeted Group. Allows the targeted UserProfile to receive notifications sent to the targeted Group |
| usersCreateNewEmail | POST /{tenantId}/directory/{directoryId}/users/{userId}/contact/emails | Create a new email to the target UserProfile if the existing email address doesn't already exist. |
| usersCreateNewLocation | POST /{tenantId}/directory/{directoryId}/users/{userId}/notifications/locations | Create a new Location for the targeted UserProfile. |
| usersCreateNewPhone | POST /{tenantId}/directory/{directoryId}/users/{userId}/contact/phones | Create a new phone number on the target UserProfile if the existing phone number doesn't already exist. |
| usersCreatePhoneVerificationNonce | POST /{tenantId}/directory/{directoryId}/users/{userId}/contact/phones/{phoneNumber}/verification/nonce | Retrieve a ResendVerificationToken to trigger the Verification Code process. Returns 429 if too many ResendVerificationTokens have been requested in the allowed time. |
| usersDelete | DELETE /{tenantId}/directory/{directoryId}/users/{userId} | Delete a UserProfile associated with a specific Tenant and Directory by the User's Identifier. |
| usersFindUsersByQuery | POST /{tenantId}/directory/{directoryId}/users/query | Retrieve a UserProfile that belongs to a specific Tenant and Directory by the User's Identifier. |
| usersGetById | GET /{tenantId}/directory/{directoryId}/users/{userId} | Retrieve a UserProfile that belongs to a specific Tenant and Directory by the User's Identifier. |
| usersGetContactInformationById | GET /{tenantId}/directory/{directoryId}/users/{userId}/contact | Retrieve a UserProfile that belongs to a specific Tenant and Directory by the User's Identifier. |
| usersGetEmail | GET /{tenantId}/directory/{directoryId}/users/{userId}/contact/emails/{emailAddress} | Retrieves details of a specific Email addresses for the targeted UserProfile. |
| usersGetLocation | GET /{tenantId}/directory/{directoryId}/users/{userId}/notifications/locations/{locationId} | Retrieves details of a specific Location for the targeted UserProfile. |
| usersGetNotificationPreferencesById | GET /{tenantId}/directory/{directoryId}/users/{userId}/notifications | Retrieve a UserProfile that belongs to a specific Tenant and Directory by the User's Identifier. |
| usersGetPhone | GET /{tenantId}/directory/{directoryId}/users/{userId}/contact/phones/{phoneNumber} | Retrieves details of a specific Phone Number for the targeted UserProfile. |
| usersGetWeatherNotifications | GET /{tenantId}/directory/{directoryId}/users/{userId}/notifications/weather | |
| usersRemoveEmail | DELETE /{tenantId}/directory/{directoryId}/users/{userId}/contact/emails/{emailAddress} | Removes an email from the targeted UserProfile. |
| usersRemoveGroupMembership | DELETE /{tenantId}/directory/{directoryId}/users/{userId}/notifications/memberships/{groupId} | Removes the targeted UserProfile as a Member from the targeted Group. This prevents the targeted UserProfile from receiving notifications sent to the targeted Group. |
| usersRemoveLocation | DELETE /{tenantId}/directory/{directoryId}/users/{userId}/notifications/locations/{locationId} | Remove an existing Location from the targeted UserProfile. |
| usersRemovePhone | DELETE /{tenantId}/directory/{directoryId}/users/{userId}/contact/phones/{phoneNumber} | Removes an Phone Number from the targeted UserProfile. |
| usersRemoveWeatherNotifications | DELETE /{tenantId}/directory/{directoryId}/users/{userId}/notifications/weather | |
| usersResendEmailVerification | POST /{tenantId}/directory/{directoryId}/users/{userId}/contact/emails/{emailAddress}/verification/resend | Send a new verification Email Address to the targeted Email. Requires a VerificationNonce to prevent excessive sending of emails to the targeted Email Address. |
| usersResendPhoneVerification | POST /{tenantId}/directory/{directoryId}/users/{userId}/contact/phones/{phoneNumber}/verification/resend | Send a new verification code to the targeted Phone Number through SMS. Requires a VerificationNonce to prevent excessive messaging of SMS messages to the targeted Phone Number. |
| usersUpdate | PUT /{tenantId}/directory/{directoryId}/users/{userId} | Modify the base information of the targeted UserProfile. |
| usersVerifyEmail | POST /{tenantId}/directory/{directoryId}/users/{userId}/contact/emails/{emailAddress}/verification/verify | Compares the last verification code sent through Email to and changes the verification status of the targeted Email Address. |
| usersVerifyPhone | POST /{tenantId}/directory/{directoryId}/users/{userId}/contact/phones/{phoneNumber}/verification/verify | Compares the last verification code sent through SMS to and changes the verification status of the targeted Phone Number. |
usersAddWeatherNotifications
usersAddWeatherNotifications(tenantId, directoryId, userId, AddWeatherNotificationsCommand)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| AddWeatherNotificationsCommand | AddWeatherNotificationsCommand | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersCreate
UserProfile usersCreate(tenantId, directoryId, CreateUserProfileCommand)
Create a new UserProfile in the targeted Tenant and Directory
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| CreateUserProfileCommand | CreateUserProfileCommand | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersCreateEmailVerificationNonce
ResendVerificationToken usersCreateEmailVerificationNonce(tenantId, directoryId, userId, emailAddress, CreateVerificationNonceCommand)
Reserve a client generated Nonce to trigger the Verification Code process. Returns 429 if too many requests have been requested in the allowed time.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| emailAddress | String | [default to null] | |
| CreateVerificationNonceCommand | CreateVerificationNonceCommand | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersCreateExternalId
usersCreateExternalId(tenantId, directoryId, userId, CreateExternalIdCommand)
Associate a new ExternalId to an existing user that belongs to a specific Tenant and Directory by the User's Identifier.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| CreateExternalIdCommand | CreateExternalIdCommand | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersCreateGroupMembership
usersCreateGroupMembership(tenantId, directoryId, userId, body)
Add the targeted UserProfile as a member of the targeted Group. Allows the targeted UserProfile to receive notifications sent to the targeted Group
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| body | String | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersCreateNewEmail
EmailAddress usersCreateNewEmail(tenantId, directoryId, userId, CreateEmailCommand)
Create a new email to the target UserProfile if the existing email address doesn't already exist.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| CreateEmailCommand | CreateEmailCommand | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersCreateNewLocation
usersCreateNewLocation(tenantId, directoryId, userId, CreateLocationCommand)
Create a new Location for the targeted UserProfile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| CreateLocationCommand | CreateLocationCommand | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersCreateNewPhone
PhoneNumber usersCreateNewPhone(tenantId, directoryId, userId, CreatePhoneCommand)
Create a new phone number on the target UserProfile if the existing phone number doesn't already exist.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| CreatePhoneCommand | CreatePhoneCommand | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersCreatePhoneVerificationNonce
ResendVerificationToken usersCreatePhoneVerificationNonce(tenantId, directoryId, userId, phoneNumber, CreateVerificationNonceCommand)
Retrieve a ResendVerificationToken to trigger the Verification Code process. Returns 429 if too many ResendVerificationTokens have been requested in the allowed time.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| phoneNumber | String | [default to null] | |
| CreateVerificationNonceCommand | CreateVerificationNonceCommand | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersDelete
usersDelete(tenantId, directoryId, userId)
Delete a UserProfile associated with a specific Tenant and Directory by the User's Identifier.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersFindUsersByQuery
UserProfileSummaryPagedApiResponse usersFindUsersByQuery(tenantId, directoryId, FindUserQuery)
Retrieve a UserProfile that belongs to a specific Tenant and Directory by the User's Identifier.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| FindUserQuery | FindUserQuery | [optional] |
Return type
UserProfileSummaryPagedApiResponse
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersGetById
UserProfile usersGetById(tenantId, directoryId, userId)
Retrieve a UserProfile that belongs to a specific Tenant and Directory by the User's Identifier.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersGetContactInformationById
ContactInformation usersGetContactInformationById(tenantId, directoryId, userId)
Retrieve a UserProfile that belongs to a specific Tenant and Directory by the User's Identifier.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersGetEmail
EmailAddress usersGetEmail(tenantId, directoryId, userId, emailAddress)
Retrieves details of a specific Email addresses for the targeted UserProfile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| emailAddress | String | [default to null] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersGetLocation
Location usersGetLocation(tenantId, directoryId, userId, locationId)
Retrieves details of a specific Location for the targeted UserProfile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| locationId | String | [default to null] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersGetNotificationPreferencesById
NotificationPreferencesSummary usersGetNotificationPreferencesById(tenantId, directoryId, userId)
Retrieve a UserProfile that belongs to a specific Tenant and Directory by the User's Identifier.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] |
Return type
NotificationPreferencesSummary
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersGetPhone
PhoneNumber usersGetPhone(tenantId, directoryId, userId, phoneNumber)
Retrieves details of a specific Phone Number for the targeted UserProfile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| phoneNumber | String | [default to null] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersGetWeatherNotifications
WeatherNotificationCollection usersGetWeatherNotifications(tenantId, directoryId, userId)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersRemoveEmail
usersRemoveEmail(tenantId, directoryId, userId, emailAddress)
Removes an email from the targeted UserProfile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| emailAddress | String | [default to null] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersRemoveGroupMembership
usersRemoveGroupMembership(tenantId, directoryId, userId, groupId)
Removes the targeted UserProfile as a Member from the targeted Group. This prevents the targeted UserProfile from receiving notifications sent to the targeted Group.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| groupId | String | [default to null] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersRemoveLocation
usersRemoveLocation(tenantId, directoryId, userId, locationId)
Remove an existing Location from the targeted UserProfile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| locationId | String | Id of the specific location to remove. | [default to null] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersRemovePhone
usersRemovePhone(tenantId, directoryId, userId, phoneNumber)
Removes an Phone Number from the targeted UserProfile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| phoneNumber | String | [default to null] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
usersRemoveWeatherNotifications
usersRemoveWeatherNotifications(tenantId, directoryId, userId, RemoveWeatherNotificationsCommand)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| RemoveWeatherNotificationsCommand | RemoveWeatherNotificationsCommand | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersResendEmailVerification
usersResendEmailVerification(tenantId, directoryId, userId, emailAddress, SendVerificationCommand)
Send a new verification Email Address to the targeted Email. Requires a VerificationNonce to prevent excessive sending of emails to the targeted Email Address.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| emailAddress | String | [default to null] | |
| SendVerificationCommand | SendVerificationCommand | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersResendPhoneVerification
usersResendPhoneVerification(tenantId, directoryId, userId, phoneNumber, SendVerificationCommand)
Send a new verification code to the targeted Phone Number through SMS. Requires a VerificationNonce to prevent excessive messaging of SMS messages to the targeted Phone Number.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| phoneNumber | String | [default to null] | |
| SendVerificationCommand | SendVerificationCommand | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersUpdate
usersUpdate(tenantId, directoryId, userId, UpdateUserProfileCommand)
Modify the base information of the targeted UserProfile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| UpdateUserProfileCommand | UpdateUserProfileCommand | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersVerifyEmail
VerificationResponse usersVerifyEmail(tenantId, directoryId, userId, emailAddress, VerifyEmailCommand)
Compares the last verification code sent through Email to and changes the verification status of the targeted Email Address.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| emailAddress | String | [default to null] | |
| VerifyEmailCommand | VerifyEmailCommand | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
usersVerifyPhone
VerificationResponse usersVerifyPhone(tenantId, directoryId, userId, phoneNumber, VerifyPhoneCommand)
Compares the last verification code sent through SMS to and changes the verification status of the targeted Phone Number.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| directoryId | String | [default to null] | |
| userId | String | [default to null] | |
| phoneNumber | String | [default to null] | |
| VerifyPhoneCommand | VerifyPhoneCommand | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json