User

Catalog


POST Change profile

Request path:

https://gateway.aiursoft.com/User/ChangeProfile

Request example:

https://gateway.aiursoft.com/User/ChangeProfile?NewNickName=yourNewNickName&NewIconFilePathName=yourNewIconFilePathName&NewBio=yourNewBio&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

NewNickName=yourNewNickName&NewIconFilePathName=yourNewIconFilePathName&NewBio=yourNewBio&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
NewNickName Required Text
NewIconFilePathName Required Text
NewBio Not required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Change password

Request path:

https://gateway.aiursoft.com/User/ChangePassword

Request example:

https://gateway.aiursoft.com/User/ChangePassword?OldPassword=yourOldPassword&NewPassword=yourNewPassword&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

OldPassword=yourOldPassword&NewPassword=yourNewPassword&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
OldPassword Required Text
NewPassword Required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET View phone number

Request path:

https://gateway.aiursoft.com/User/ViewPhoneNumber

Request example:

https://gateway.aiursoft.com/User/ViewPhoneNumber?AccessToken=yourAccessToken&OpenId=yourOpenId

Try

Request arguments:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "value": "an example string.",
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Set phone number

Request path:

https://gateway.aiursoft.com/User/SetPhoneNumber

Request example:

https://gateway.aiursoft.com/User/SetPhoneNumber?Phone=yourPhone&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

Phone=yourPhone&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
Phone Not required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET View all emails

Request path:

https://gateway.aiursoft.com/User/ViewAllEmails

Request example:

https://gateway.aiursoft.com/User/ViewAllEmails?AccessToken=yourAccessToken&OpenId=yourOpenId

Try

Request arguments:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "items": [
    {
      "id": 0,
      "emailAddress": "an example string.",
      "validated": true
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Bind new email

Request path:

https://gateway.aiursoft.com/User/BindNewEmail

Request example:

https://gateway.aiursoft.com/User/BindNewEmail?NewEmail=yourNewEmail&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

NewEmail=yourNewEmail&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
NewEmail Required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Delete email

Request path:

https://gateway.aiursoft.com/User/DeleteEmail

Request example:

https://gateway.aiursoft.com/User/DeleteEmail?ThatEmail=yourThatEmail&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

ThatEmail=yourThatEmail&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
ThatEmail Required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Send confirmation email

Request path:

https://gateway.aiursoft.com/User/SendConfirmationEmail

Request example:

https://gateway.aiursoft.com/User/SendConfirmationEmail?Email=yourEmail&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

Email=yourEmail&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
Email Required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Set primary email

Request path:

https://gateway.aiursoft.com/User/SetPrimaryEmail

Request example:

https://gateway.aiursoft.com/User/SetPrimaryEmail?Email=yourEmail&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

Email=yourEmail&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
Email Required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET View granted apps

Request path:

https://gateway.aiursoft.com/User/ViewGrantedApps

Request example:

https://gateway.aiursoft.com/User/ViewGrantedApps?AccessToken=yourAccessToken&OpenId=yourOpenId

Try

Request arguments:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "items": [
    {
      "userInfo": null,
      "appID": "an example string.",
      "grantTime": "2020-04-08T21:00:41.6145173Z",
      "gatewayUserId": "an example string."
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Drop granted apps

Request path:

https://gateway.aiursoft.com/User/DropGrantedApps

Request example:

https://gateway.aiursoft.com/User/DropGrantedApps?AppIdToDrop=yourAppIdToDrop&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

AppIdToDrop=yourAppIdToDrop&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
AppIdToDrop Required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET View audit log

Request path:

https://gateway.aiursoft.com/User/ViewAuditLog

Request example:

https://gateway.aiursoft.com/User/ViewAuditLog?PageSize=0&PageNumber=0&AccessToken=yourAccessToken&OpenId=yourOpenId

Try

Request arguments:

Name Required Type
PageSize Required Number
PageNumber Required Number
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "totalCount": 0,
  "currentPage": 0,
  "currentPageSize": 0,
  "items": [
    {
      "id": 0,
      "userId": "an example string.",
      "appId": "an example string.",
      "happenTime": "2020-04-08T21:00:41.6165852Z",
      "success": true,
      "ipAddress": "an example string."
    },
    {
      "id": 0,
      "userId": "an example string.",
      "appId": "an example string.",
      "happenTime": "2020-04-08T21:00:41.616798Z",
      "success": true,
      "ipAddress": "an example string."
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET View social accounts

Request path:

https://gateway.aiursoft.com/User/ViewSocialAccounts

Request example:

https://gateway.aiursoft.com/User/ViewSocialAccounts?AccessToken=yourAccessToken&OpenId=yourOpenId

Try

Request arguments:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "items": [
    {
      "name": "an example string.",
      "providerName": "an example string.",
      "bindTime": "2020-04-08T21:00:41.6230756Z"
    },
    {
      "name": "an example string.",
      "providerName": "an example string.",
      "bindTime": "2020-04-08T21:00:41.6233295Z"
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Un bind social account

Request path:

https://gateway.aiursoft.com/User/UnBindSocialAccount

Request example:

https://gateway.aiursoft.com/User/UnBindSocialAccount?ProviderName=yourProviderName&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

ProviderName=yourProviderName&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
ProviderName Not required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST View has2 f akey

Request path:

https://gateway.aiursoft.com/User/ViewHas2FAkey

Request example:

https://gateway.aiursoft.com/User/ViewHas2FAkey?AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "value": true,
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST View two factor enabled

Request path:

https://gateway.aiursoft.com/User/ViewTwoFactorEnabled

Request example:

https://gateway.aiursoft.com/User/ViewTwoFactorEnabled?AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "value": true,
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST View2 f a key

Request path:

https://gateway.aiursoft.com/User/View2FAKey

Request example:

https://gateway.aiursoft.com/User/View2FAKey?AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "twoFAKey": "an example string.",
  "twoFAQRUri": "an example string.",
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Set two f a key

Request path:

https://gateway.aiursoft.com/User/SetTwoFAKey

Request example:

https://gateway.aiursoft.com/User/SetTwoFAKey?AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "value": true,
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Reset two f a key

Request path:

https://gateway.aiursoft.com/User/ResetTwoFAKey

Request example:

https://gateway.aiursoft.com/User/ResetTwoFAKey?AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Two f a verificy code

Request path:

https://gateway.aiursoft.com/User/TwoFAVerificyCode

Request example:

https://gateway.aiursoft.com/User/TwoFAVerificyCode?Code=yourCode&AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

Code=yourCode&AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
Code Required Text
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "value": true,
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Disable two f a

Request path:

https://gateway.aiursoft.com/User/DisableTwoFA

Request example:

https://gateway.aiursoft.com/User/DisableTwoFA?AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "value": true,
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Get recovery codes

Request path:

https://gateway.aiursoft.com/User/GetRecoveryCodes

Request example:

https://gateway.aiursoft.com/User/GetRecoveryCodes?AccessToken=yourAccessToken&OpenId=yourOpenId

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&OpenId=yourOpenId 

Request form:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "items": [
    "an example string."
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}