Cdn API - CPG Source

<back to all web services

CognitoSendSignUpRequest

Cdn.Api

The following routes are available for this service:
POST/CognitoSendSignUpRequest
CognitoSendSignUpRequest Parameters:
NameParameterData TypeRequiredDescription
EmailAddressbodystringNo
PasswordbodystringNo
FirstNamebodystringNo
LastNamebodystringNo
CognitoSendSignUpResponse Parameters:
NameParameterData TypeRequiredDescription
DataformSignUpResponseNo
UserTest1formCognitoUserNo
UserTest2formCognitoUserNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
SignUpResponse Parameters:
NameParameterData TypeRequiredDescription
CodeDeliveryDetailsformCodeDeliveryDetailsTypeNo
UserConfirmedformboolNo
UserSubformstringNo
AmazonWebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ContentLengthformlongNo
HttpStatusCodeformHttpStatusCodeNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
RequestIdformstringNo
MetadataformIDictionary<string, string>No
ChecksumAlgorithmformCoreChecksumAlgorithmNo
ChecksumValidationStatusformChecksumValidationStatusNo
CodeDeliveryDetailsType Parameters:
NameParameterData TypeRequiredDescription
AttributeNameformstringNo
DeliveryMediumformDeliveryMediumTypeNo
DestinationformstringNo
ConstantClass Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
CognitoUser Parameters:
NameParameterData TypeRequiredDescription
SessionTokensformCognitoUserSessionNo
DeviceformCognitoDeviceNo
UserIDformstringNo
UsernameformstringNo
UserPoolformCognitoUserPoolNo
ClientIDformstringNo
StatusformstringNo
AttributesformDictionary<string, string>No
SettingsformDictionary<string, string>No
CognitoUserSession Parameters:
NameParameterData TypeRequiredDescription
IdTokenformstringNo
AccessTokenformstringNo
RefreshTokenformstringNo
ExpirationTimeformDateTimeNo
IssuedTimeformDateTimeNo
CognitoDevice Parameters:
NameParameterData TypeRequiredDescription
DeviceKeyformstringNo
DeviceAttributesformDictionary<string, string>No
CreateDateformDateTimeNo
LastModifiedformDateTimeNo
LastAuthenticatedformDateTimeNo
UserformCognitoUserNo
GroupDeviceKeyformstringNo
DeviceSecretformstringNo
CognitoUserPool Parameters:
NameParameterData TypeRequiredDescription
PoolIDformstringNo
ClientIDformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}