| POST | /CognitoSendSignUpRequest |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmailAddress | body | string | No | |
| Password | body | string | No | |
| FirstName | body | string | No | |
| LastName | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | SignUpResponse | No | |
| UserTest1 | form | CognitoUser | No | |
| UserTest2 | form | CognitoUser | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Total | form | int | No | |
| OpCode | form | int | No | |
| ErrorText | form | string | No | |
| RequestTime | form | string | No | |
| ResponseTime | form | string | No | |
| TotalExecutionTime | form | string | No | |
| CachedResponse | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CodeDeliveryDetails | form | CodeDeliveryDetailsType | No | |
| UserConfirmed | form | bool | No | |
| UserSub | 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttributeName | form | string | No | |
| DeliveryMedium | form | DeliveryMediumType | No | |
| Destination | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SessionTokens | form | CognitoUserSession | No | |
| Device | form | CognitoDevice | No | |
| UserID | form | string | No | |
| Username | form | string | No | |
| UserPool | form | CognitoUserPool | No | |
| ClientID | form | string | No | |
| Status | form | string | No | |
| Attributes | form | Dictionary<string, string> | No | |
| Settings | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdToken | form | string | No | |
| AccessToken | form | string | No | |
| RefreshToken | form | string | No | |
| ExpirationTime | form | DateTime | No | |
| IssuedTime | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeviceKey | form | string | No | |
| DeviceAttributes | form | Dictionary<string, string> | No | |
| CreateDate | form | DateTime | No | |
| LastModified | form | DateTime | No | |
| LastAuthenticated | form | DateTime | No | |
| User | form | CognitoUser | No | |
| GroupDeviceKey | form | string | No | |
| DeviceSecret | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PoolID | form | string | No | |
| ClientID | 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 /CognitoSendSignUpRequest HTTP/1.1
Host: cdnapidev.greysheet.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
EmailAddress: String,
Password: String,
FirstName: String,
LastName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Data:
{
CodeDeliveryDetails:
{
AttributeName: String,
Destination: String
},
UserConfirmed: False,
UserSub: String,
ResponseMetadata:
{
RequestId: String,
Metadata: {},
ChecksumAlgorithm: NONE,
ChecksumValidationStatus: NOT_VALIDATED
},
ContentLength: 0,
HttpStatusCode: Continue
},
Total: 0,
OpCode: 0,
ErrorText: String,
RequestTime: String,
ResponseTime: String,
TotalExecutionTime: String,
CachedResponse: False
}