Identity API

Manages player authentication and provides unique player identities.

When a player logs in or registers, the Game Provider communicates with the Identity API to authenticate the player and retrieve their unique identifier. This identifier is essential for all subsequent interactions.

delete

Path parameters

idstring · uuidRequired

Responses

200

resultinteger · enumOptionalPossible values:

400

Bad Request

404

Not Found

delete

/api/identity/{id}/ban

DELETE /api/identity/{id}/ban HTTP/1.1
Accept: */*

{
  "result": 0
}

delete

Path parameters

idstring · uuidRequired

Responses

200

resultinteger · enumOptionalPossible values:

400

Bad Request

404

Not Found

delete

/api/identity/{id}/delete

DELETE /api/identity/{id}/delete HTTP/1.1
Accept: */*

{
  "result": 0
}

post

Path parameters

idstring · uuidRequired

Body

typeinteger · enumOptionalPossible values:

countryCodestring · nullableOptional

areaCodestring · nullableOptional

phoneNumberstring · nullableOptional

emailstring · nullableOptional

codestring · nullableOptional

platforminteger · enumOptionalPossible values:

Responses

200

resultinteger · enumOptionalPossible values:

400

Bad Request

post

/api/identity/{id}/verify

POST /api/identity/{id}/verify HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "type": 0,
  "countryCode": "text",
  "areaCode": "text",
  "phoneNumber": "text",
  "email": "text",
  "code": "text",
  "platform": 0
}

{
  "result": 0
}

post

Body

searchstring · nullableOptional

Responses

200

idstring · uuidOptional

emailstring · nullableOptional

idpTypeinteger · enumOptionalPossible values:

400

Bad Request

post

/api/identity/accountquery

POST /api/identity/accountquery HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "search": "text"
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "idpType": 0
  }
]

post

Body

emailstring · nullableOptional

Responses

200

idstring · uuidOptional

emailstring · nullableOptional

idpTypeinteger · enumOptionalPossible values:

400

Bad Request

404

Not Found

post

/api/identity/accountquery/email

POST /api/identity/accountquery/email HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "email": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "idpType": 0
}

post

Body

idstring · uuidOptional

Responses

200

idstring · uuidOptional

emailstring · nullableOptional

idpTypeinteger · enumOptionalPossible values:

400

Bad Request

404

Not Found

post

/api/identity/accountquery/id

POST /api/identity/accountquery/id HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "idpType": 0
}

post

Body

Responses

200

string[]Optional

404

Not Found

post

/api/identity/externalsignup

POST /api/identity/externalsignup HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "externaSignUpUserModel": [
    {
      "firstName": "text",
      "lastName": "text"
    }
  ]
}

[
  "text"
]

Body

firstNamestring · nullableOptional

lastNamestring · nullableOptional

emailstring · nullableOptional

passwordstring · nullableOptional

Responses

200

No content

400

Bad Request

403

Forbidden

post

/api/identity/signup

POST /api/identity/signup HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "password": "text"
}

No content

PreviousIntegration Flow NextRoom Manager API

Last updated 11 months ago