User

Catalog


POST Change profile

Request path:

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

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 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/ViewPhoneNumberTry

Request example:

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

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 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/ViewAllEmailsTry

Request example:

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

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 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 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 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 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/ViewGrantedAppsTry

Request example:

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

Request arguments:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "Items": [
    {
      "UserInfo": null,
      "AppID": "an example string.",
      "GrantTime": "2019-11-18T21:00:42.737443Z",
      "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 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/ViewAuditLogTry

Request example:

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

Request arguments:

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

Possible Response:

{
  "TotalCount": 0,
  "Items": [
    {
      "Id": 0,
      "UserId": "an example string.",
      "AppId": "an example string.",
      "HappenTime": "2019-11-18T21:00:42.7380664Z",
      "Success": true,
      "IPAddress": "an example string."
    },
    {
      "Id": 0,
      "UserId": "an example string.",
      "AppId": "an example string.",
      "HappenTime": "2019-11-18T21:00:42.7381169Z",
      "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/ViewSocialAccountsTry

Request example:

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

Request arguments:

Name Required Type
AccessToken Required Text
OpenId Required Text

Possible Response:

{
  "Items": [
    {
      "ProviderName": "an example string.",
      "BindTime": "2019-11-18T21:00:42.7386413Z"
    },
    {
      "ProviderName": "an example string.",
      "BindTime": "2019-11-18T21:00:42.7386906Z"
    }
  ],
  "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 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 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 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 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 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 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 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 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 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!"
}