User

Catalog

• Change profile
• Change password
• View phone number
• Set phone number
• View all emails
• Bind new email
• Delete email
• Send confirmation email
• Set primary email
• View granted apps
• Drop granted apps
• View audit log
• View social accounts
• Un bind social account
• View has2 f a key
• View two factor enabled
• View2 f a key
• Set two f a key
• Reset two f a key
• Two f a verify code
• Disable two f a
• Get recovery codes

---

POST Change profile

Request path:

https://directory.aiursoft.com/User/ChangeProfileCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

POST Change password

Request path:

https://directory.aiursoft.com/User/ChangePasswordCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

GET View phone number

Request path:

https://directory.aiursoft.com/User/ViewPhoneNumberCopy

Request example:

https://directory.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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST Set phone number

Request path:

https://directory.aiursoft.com/User/SetPhoneNumberCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

GET View all emails

Request path:

https://directory.aiursoft.com/User/ViewAllEmailsCopy

Request example:

https://directory.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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST Bind new email

Request path:

https://directory.aiursoft.com/User/BindNewEmailCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

POST Delete email

Request path:

https://directory.aiursoft.com/User/DeleteEmailCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

POST Send confirmation email

Request path:

https://directory.aiursoft.com/User/SendConfirmationEmailCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

POST Set primary email

Request path:

https://directory.aiursoft.com/User/SetPrimaryEmailCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

GET View granted apps

Request path:

https://directory.aiursoft.com/User/ViewGrantedAppsCopy

Request example:

https://directory.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": "2023-10-01T22:26:01.2224045Z",
      "directoryUserId": "an example string."
    }
  ],
  "code": 0,
  "message": "an example string.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST Drop granted apps

Request path:

https://directory.aiursoft.com/User/DropGrantedAppsCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

GET View audit log

Request path:

https://directory.aiursoft.com/User/ViewAuditLogCopy

Request example:

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

Try

Request arguments:

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

Possible Response:

{
  "totalCount": 0,
  "currentPage": 0,
  "currentPageSize": 0,
  "items": [
    {
      "id": 0,
      "userId": "an example string.",
      "appId": "an example string.",
      "happenTime": "2023-10-01T22:26:01.2264167Z",
      "success": true,
      "ipAddress": "an example string."
    },
    {
      "id": 0,
      "userId": "an example string.",
      "appId": "an example string.",
      "happenTime": "2023-10-01T22:26:01.226752Z",
      "success": true,
      "ipAddress": "an example string."
    }
  ],
  "code": 0,
  "message": "an example string.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

GET View social accounts

Request path:

https://directory.aiursoft.com/User/ViewSocialAccountsCopy

Request example:

https://directory.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": "2023-10-01T22:26:01.2346469Z"
    },
    {
      "name": "an example string.",
      "providerName": "an example string.",
      "bindTime": "2023-10-01T22:26:01.2350331Z"
    }
  ],
  "code": 0,
  "message": "an example string.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST Un bind social account

Request path:

https://directory.aiursoft.com/User/UnBindSocialAccountCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

POST View has2 f a key

Request path:

https://directory.aiursoft.com/User/ViewHas2FAKeyCopy

Request example:

https://directory.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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST View two factor enabled

Request path:

https://directory.aiursoft.com/User/ViewTwoFactorEnabledCopy

Request example:

https://directory.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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST View2 f a key

Request path:

https://directory.aiursoft.com/User/View2FAKeyCopy

Request example:

https://directory.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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST Set two f a key

Request path:

https://directory.aiursoft.com/User/SetTwoFAKeyCopy

Request example:

https://directory.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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST Reset two f a key

Request path:

https://directory.aiursoft.com/User/ResetTwoFAKeyCopy

Request example:

https://directory.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.",
  "protocolVersion": "7.0.2.0"
}

Possible Response:

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

---

POST Two f a verify code

Request path:

https://directory.aiursoft.com/User/TwoFAVerifyCodeCopy

Request example:

https://directory.aiursoft.com/User/TwoFAVerifyCode?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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST Disable two f a

Request path:

https://directory.aiursoft.com/User/DisableTwoFACopy

Request example:

https://directory.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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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

---

POST Get recovery codes

Request path:

https://directory.aiursoft.com/User/GetRecoveryCodesCopy

Request example:

https://directory.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.",
  "protocolVersion": "0.0.0.0"
}

Possible Response:

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

Possible Response:

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