| GET,PUT,POST,OPTIONS | /v1/userverifyemail |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | body | Guid | No | |
| VerificationCode | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| InitiateAuthResponse | form | InitiateAuthResponse | No | |
| Success | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AuthenticationResult | form | AuthenticationResultType | No | |
| ChallengeName | form | ChallengeNameType | No | |
| ChallengeParameters | form | Dictionary<string, string> | No | |
| Session | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseMetadata | form | ResponseMetadata | No | |
| ContentLength | form | long | No | |
| HttpStatusCode | form | HttpStatusCode | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestId | form | string | No | |
| Metadata | form | IDictionary<string, string> | No | |
| ChecksumAlgorithm | form | CoreChecksumAlgorithm | No | |
| ChecksumValidationStatus | form | ChecksumValidationStatus | No |
| NONE | |
| CRC32C | |
| CRC32 | |
| SHA256 | |
| SHA1 |
| NOT_VALIDATED | |
| PENDING_RESPONSE_READ | |
| SUCCESSFUL | |
| INVALID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccessToken | form | string | No | |
| ExpiresIn | form | int | No | |
| IdToken | form | string | No | |
| NewDeviceMetadata | form | NewDeviceMetadataType | No | |
| RefreshToken | form | string | No | |
| TokenType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeviceGroupKey | form | string | No | |
| DeviceKey | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/userverifyemail HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
UserId: 00000000000000000000000000000000,
VerificationCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
InitiateAuthResponse:
{
AuthenticationResult:
{
AccessToken: String,
ExpiresIn: 0,
IdToken: String,
NewDeviceMetadata:
{
DeviceGroupKey: String,
DeviceKey: String
},
RefreshToken: String,
TokenType: String
},
ChallengeParameters:
{
String: String
},
Session: String,
ResponseMetadata:
{
RequestId: String,
Metadata: {},
ChecksumAlgorithm: NONE,
ChecksumValidationStatus: NOT_VALIDATED
},
ContentLength: 0,
HttpStatusCode: Continue
},
Success: False
}