Utilisateurs

Ces points de terminaison requiĂšrent users.query API Role!

Liste Utilisateurs

RécupÚre les utilisateurs du serveur avec leur id et les informations stockées.

RequĂȘte

URL : /api/v1/users

MĂ©thode : GET

Autorisation Requise : Yes

ParamĂȘtres RequĂȘte

NomTypeDescriptionRequisPar DĂ©faut
pageintDécalage des utilisateurs en numéro de page:heavy_minus_sign:0
pageSizeintNombre d’utilisateurs par page:heavy_minus_sign:5
limitintLimite du nombre d’utilisateurs retournĂ©s:heavy_minus_sign:pageSize

Exemple

GET /api/v1/users?page=32&pageSize=5

RĂ©ponse

Status Code: 200 OK
Content-Type: application/json; charset=utf-8
{
	"Total": 162,
	"Page": 32,
	"PageSize": 5,
	"Count": 2,
	"Values": [
		{
			"Id": "f71a2f48-ce7b-4420-ae37-8802b8c4fb60",
			"Name": "tester",
			"Email": "testr@testr.com",
			"Power": {
				"Editor": false,
				"Ban": false,
				"Kick": false,
				"Mute": false,
				"Api": false,
				"PersonalInformation": false
			},
			"PasswordResetCode": null,
			"IsMuted": false,
			"MuteReason": null
		},
		{
			"Id": "fb19a81b-000f-4679-b30d-778dc8895594",
			"Name": "jcsnider",
			"Email": "test@test.com",
			"Power": {
				"Editor": false,
				"Ban": false,
				"Kick": false,
				"Mute": false,
				"Api": false,
				"PersonalInformation": false
			},
			"PasswordResetCode": null,
			"IsMuted": false,
			"MuteReason": null
		}
	]
}

Recherche Utilisateur

RĂ©cupĂšre un utilisateur du serveur par recherche avec leur nom d’utilisateur ou leur id.

RequĂȘte

URL : /api/v1/users/[lookupKey]

Clé de Recherche : Username or user id.

MĂ©thode : GET

Autorisation Requise : Yes

Type Contenus : application/json

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
	"Id": "fb19a81b-000f-4679-b30d-778dc8895594",
	"Name": "jcsnider",
	"Email": "test@test.com",
	"Power": {
		"Editor": false,
		"Ban": false,
		"Kick": false,
		"Mute": false,
		"Api": false,
		"PersonalInformation": false
	},
	"PasswordResetCode": null,
	"IsMuted": false,
	"MuteReason": null
}

Enregistrer Utilisateur

CrĂ©Ă© un compte sur le serveur pour un joueur qui a donnĂ© son nom d’utilisateur, son mot de passe et son adresse email.

RequĂȘte

URL : /api/v1/users/register

MĂ©thode : POST

Autorisation Requise : Oui

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
usernamestringNom d’utilisateur pour le nouvel utilisateur.:heavy_check_mark:
passwordstringHash sha256 du mot de passe du nouvel utilisateur.:heavy_check_mark:
emailstringAdresse Email pour le nouvel utilisateur.:heavy_check_mark:

Exemple

{
	"username": "jcsnider",
	"password": "5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8",
	"email": "jcsnider@ascensiongamedev.com"
}

Notes

  • Le mot de passe doit ĂȘtre un hash SHA256 du texte en clair du mot de passe, avec les traits d’union retirĂ©s.
  • Vous pouvez gĂ©nĂ©rer un hash SHA256 du texte en clair du mot de passe ici.

RĂ©ponse

Condition : Utilisateur créé avec succÚs.

Code : 200 OK

Exemple

{
	"Username": "jcsnider",
	"Email": "jcsnider@ascensiongamedev.com"
}

Valider Mot de Passe

VĂ©rifie si un mot de passe utilisateur est valide.

RequĂȘte

URL : /api/v1/users/[lookupKey]/password/validate

Clé de Recherche : Username or user id.

MĂ©thode : POST

Autorisation Requise : Oui

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
passwordstringHash SHA256 du mot de passe pour valider.:heavy_check_mark:

Exemple

{
	"password": "5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8"
}

RĂ©ponse

Condition : Le mot de passe est valide.

Code : 200 OK

Exemple

{
	"Message": "Password Correct"
}

Changer Email

Change l’adresse email associĂ©e Ă  un utilisateur ayant donnĂ© le mot de passe utilisateur.

RequĂȘte

URL : /api/v1/users/[lookupKey]/email/change

Clé de Recherche : Username or user id.

MĂ©thode : POST

Autorisation Requise : Oui

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
newstringL’adresse email.:heavy_check_mark:
authorizationstringLe hash sha256 du mot de passe actuel de l’utilisateur.:heavy_check_mark:

Exemple

{
	"new": "test100@test.com",
	"authorization": "5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8"
}

RĂ©ponse

Condition : L’ email a Ă©tĂ© changĂ©.

Code : 200 OK

Exemple

{
	"Id": "cf995c16-8c2e-4ab3-a5b8-a39d6051adc6",
	"Name": "jcsnider",
	"Email": "test100@test.com",
	"Power": {
		"Editor": true,
		"Ban": true,
		"Kick": true,
		"Mute": true,
		"Api": true,
		"ApiPersonalInformation": true,
		"ApiUserManagement": true
	},
	"PasswordResetCode": null,
	"IsMuted": false,
	"MuteReason": null
}

Changer Mot de Passe

Change le mot de passe associĂ© d’un utilisateur ayant donnĂ© le mot de passe actuel.

RequĂȘte

URL : /api/v1/users/[lookupKey]/password/change

Clé de Recherche : Username or user id.

MĂ©thode : POST

Autorisation Requise : Oui

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
newstringLe hash sha256 du nouveau mot de passe de l’utilisateur.:heavy_check_mark:
authorizationstringLe hash sha256 du mot de passe actuel de l’utilisateur.:heavy_check_mark:

Exemple

{
	"new": "1B4F0E9851971998E732078544C96B36C3D01CEDF7CAA332359D6F1D83567014",
	"authorization": "5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8"
}

RĂ©ponse

Condition : Le mot de passe a été changé.

Code : 200 OK

Exemple

{
	"Message": "Password Updated"
}

Notes

  • Le mot de passe doit ĂȘtre un hash SHA256 du texte en clair du mot de passe, avec les traits d’union retirĂ©s.
  • Vous pouvez gĂ©nĂ©rer un hash SHA256 du texte en clair du mot de passe ici.

RequĂȘte Email RĂ©initialisation Mot de Passe

Envoie Ă  l’utilisateur un code de rĂ©initialisation de mot de passe. Cela requiert que les rĂ©glages SMTP du serveur soient configurĂ©s.

RequĂȘte

URL : /api/v1/users/[lookupKey]/password/reset

Clé de Recherche : Username or user id.

MĂ©thode : GET

Autorisation Requise : Yes

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : L’ email a Ă©tĂ© envoyĂ©.

Code : 200 OK

Exemple

{
	"Message": "Password reset email sent."
}

Obtenir Personnages

Retourne un tableau des personnages d’un utilisateur.

RequĂȘte

URL : /api/v1/users/[lookupKey]/players

Clé de Recherche : Username or user id.

MĂ©thode : GET

Autorisation Requise : Yes

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : Personnages trouvés.

Code : 200 OK

Exemple

[
    {"Name": "deleteme", "InBank": false, "UserId": "cf995c16-8c2e-4ab3-a5b8-a39d6051adc6", "MaxVitals":[510,
},
    {"Name": "jcsnider", "InBank": false, "UserId": "cf995c16-8c2e-4ab3-a5b8-a39d6051adc6", "MaxVitals":[1680,
},
    {"Name": "sadasd23", "InBank": false, "UserId": "cf995c16-8c2e-4ab3-a5b8-a39d6051adc6", "MaxVitals":[500,
}
]

L’exemple est tronquĂ©, pour une rĂ©ponse complĂšte cliquez ici.

Obtenir Personnage

Retourne un des personnages de cet utilisateur

RequĂȘte

URL : /api/v1/users/[lookupKey1]/players/[lookupKey2]

Clé de Recherche 1 : Username or user id.

Clé de Recherche 2 : Character name, character id, or integer index of character in characters list.

MĂ©thode : GET

Autorisation Requise : Oui

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : Personnage trouvé.

Code : 200 OK

Example

{
    "Name": "jcsnider",
    "InBank": false,
    "UserId": "cf995c16-8c2e-4ab3-a5b8-a39d6051adc6",
    "MaxVitals":[
    1680,
    510
    ],
    ...
}

L’exemple est tronquĂ©, pour une rĂ©ponse complĂšte cliquez ici.

Changer l’Email (w/ Rîle Users.Manage)

Change l’adresse email d’un utilisateur sans son mot de passe. Requiert le rîle Users.Manage .

RequĂȘte

URL : /api/v1/users/[lookupKey]/manage/email/change

Clé de Recherche : Username or user id.

MĂ©thode : POST

Autorisation Requise : Yes

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
newstringLa nouvelle adresse email.:heavy_check_mark:

Exemple

{
	"new": "test100@test.com"
}

RĂ©ponse

Condition : L’email a Ă©tĂ© changĂ©.

Code : 200 OK

Exemple

{
	"Id": "cf995c16-8c2e-4ab3-a5b8-a39d6051adc6",
	"Name": "jcsnider",
	"Email": "test100@test.com",
	"Power": {
		"Editor": true,
		"Ban": true,
		"Kick": true,
		"Mute": true,
		"Api": true,
		"ApiPersonalInformation": true,
		"ApiUserManagement": true
	},
	"PasswordResetCode": null,
	"IsMuted": false,
	"MuteReason": null
}

Changer Mot de Passe (w/ RĂŽle Users.Manage)

Change le mot de passe d’un utilisateur sans son mot de passe existant. Requiert le rîle the Users.Manage .

RequĂȘte

URL : /api/v1/users/[lookupKey]/manage/password/change

Clé de Recherche : Username or user id.

MĂ©thode : POST

Autorisation Requise : Yes

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
newstringLe hash sha256 du nouveau mot de passe de l’utilisateur.:heavy_check_mark:

Exemple

{
	"new": "1B4F0E9851971998E732078544C96B36C3D01CEDF7CAA332359D6F1D83567014"
}

Notes

  • Le mot de passe doit ĂȘtre un hash SHA256 du texte en clair du mot de passe, avec les traits d’union retirĂ©s.
  • Vous pouvez gĂ©nĂ©rer un hash SHA256 du texte en clair du mot de passe ici.

RĂ©ponse

Condition : Le mot de passe a été changé.

Code : 200 OK

Exemple

{
	"Message": "Password Correct"
}

Notes

  • Le mot de passe doit ĂȘtre un hash SHA256 du texte en clair du mot de passe, avec les traits d’union retirĂ©s.
  • Vous pouvez gĂ©nĂ©rer un hash SHA256 du texte en clair du mot de passe ici.

Liste Utilisateurs (POST) (ObsolĂšte)

RécupÚre des utilisateurs du serveur avec leur id et les informations stockées.

RequĂȘte

URL : /api/v1/users

MĂ©thode : POST

Autorisation Requise : Yes

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
pageintPage d’utilisateurs Ă  rĂ©cupĂ©rer.:heavy_minus_sign:
countintNombre d’utilisateurs Ă  rĂ©cupĂ©rer.:heavy_minus_sign:

Exemple

{
	"page": 32,
	"count": 5
}

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
	"total": 162,
	"Page": 32,
	"count": 2,
	"entries": [
		{
			"Id": "f71a2f48-ce7b-4420-ae37-8802b8c4fb60",
			"Name": "tester",
			"Email": "testr@testr.com",
			"Power": {
				"Editor": false,
				"Ban": false,
				"Kick": false,
				"Mute": false,
				"Api": false,
				"PersonalInformation": false
			},
			"PasswordResetCode": null,
			"IsMuted": false,
			"MuteReason": null
		},
		{
			"Id": "fb19a81b-000f-4679-b30d-778dc8895594",
			"Name": "jcsnider",
			"Email": "test@test.com",
			"Power": {
				"Editor": false,
				"Ban": false,
				"Kick": false,
				"Mute": false,
				"Api": false,
				"PersonalInformation": false
			},
			"PasswordResetCode": null,
			"IsMuted": false,
			"MuteReason": null
		}
	]
}