UserBasicAuthentication() Parent topic

Description

Manage user logon credentials.

Interface

https://[SecureCloudService]/broker/API.svc/v3.5/userBasicAuth/{id}?tenant={tenant}
Method: POST

Prerequisite

Call [GET] PublicCertificate/ to get public key first.

Parameters

Parameter
Data Type
Description
Required?
id
String
The user name.
Yes
tenant
String
The identifier of the tenant this account is connected to.
No

Request

Parameter
Data Type
Description
Required?
authentication.id
String
The account user name used for logon.
Valid value: any string of 1-4000 characters
No
authentication.data
String
The account's encrypted password.
Valid value: any string of 1-1024 characters
Constraint: Passwords should have RSA encryption. To obtain a public key, call POST PublicCertificate/.
The relevant conditions for RSA encryption are:
  1. Optimal Asymmetric Encryption Padding (OAEP)
  2. Hash algorithm—SHA-256
Yes
authentication.accountId
GUID
The account identifier.
No

Response

Expected HTTP response code: 200 (OK)
Parameter
Data Type
Description
Required?
authenticationResult.id
GUID
The GUID of the user who is currently logged on.
Valid value: any string of 1-4000 characters
Yes
authenticationResult.token
String
The user access token.
Yes
authenticationResult.expires
DateTime
The token's expiration time.
Valid value: a date and time in the format "yyyy-MM-ddThh:mm:ss.sss, UTC"
Yes

Example Request

[POST]
https://SecureCloudService/broker/API.svc/v3.5/PublicCertificate/

Example Response

<authenticationResult id="69f48b29-8dd6-46fe-b249-5e9563c824c0"
token="ZWExMTU3MmUtNzRiYy00NjY1LTk4MzQtZjY0NGE4ZTU1YWF1fFoya1NK
    RXJ2SDRxeGt6QzJMajBTMXc9PQ=="
expires="2012-08-07T07:11:49.7371953Z"/>