{"info":{"title":"accounts object","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/object/accounts/{objectId}/admin/email":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailUpdateRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/accounts/{objectId}/available-roles":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableRolesResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/accounts/{objectId}/role/report":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountRolesReport"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{"user":["admin"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/accounts/{objectId}/role":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRole"}}}},"security":[{"user":["admin"]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRole"}}}},"security":[{"user":["admin"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/accounts/{objectId}/admin/scope":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRole"}}}},"security":[{"user":["admin"]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRole"}}}},"security":[{"user":["admin"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/accounts/{objectId}/admin/third-party":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferThirdPartyAssociation"}}}},"security":[{"user":["developer"]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteThirdPartyAssociation"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/accounts/{objectId}/":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUpdate"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/accounts/{objectId}/admin/forget":{"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string","x-beamable-semantic-type":"AccountId"},"description":"AccountId of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{"user":["admin"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]}},"components":{"schemas":{"AccountUpdate":{"properties":{"thirdParty":{"type":"string"},"hasThirdPartyToken":{"type":"boolean"},"country":{"type":"string"},"external":{"type":"array","items":{"$ref":"#/components/schemas/ExternalIdentity"}},"language":{"type":"string"},"gamerTagAssoc":{"$ref":"#/components/schemas/GamerTagAssociation"},"token":{"type":"string"},"deviceId":{"type":"string"},"userName":{"type":"string"}},"additionalProperties":false,"title":"Account Update","type":"object","required":["hasThirdPartyToken"]},"EmailUpdateRequest":{"properties":{"newEmail":{"type":"string"},"codeType":{"type":"string"}},"additionalProperties":false,"title":"Email Update Request","type":"object","required":["newEmail"]},"ThirdPartyAssociation":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"email":{"type":"string"},"userBusinessId":{"type":"string"},"userAppId":{"type":"string"},"meta":{"type":"object","additionalProperties":{"type":"string"}},"appId":{"type":"string"}},"required":["name","appId","userAppId","meta"]},"InFlightMessage":{"type":"object","additionalProperties":false,"properties":{"method":{"type":"string"},"body":{"type":"string"},"path":{"type":"string"},"gamerTag":{"type":"integer","format":"int64"},"limitFailureRetries":{"type":"boolean"},"shard":{"type":"string"},"service":{"type":"string"},"id":{"type":"string"}},"required":["service","id","method","path","body"]},"AccountRolesReport":{"properties":{"accountId":{"type":"integer","format":"int64"},"email":{"type":"string"},"realms":{"type":"array","items":{"$ref":"#/components/schemas/RealmRolesReport"}}},"additionalProperties":false,"title":"Account Roles Report","type":"object","required":["accountId","email","realms"]},"DeleteThirdPartyAssociation":{"properties":{"thirdParty":{"type":"string"},"userAppId":{"type":"string"}},"additionalProperties":false,"title":"Delete Third Party Association","type":"object","required":["thirdParty","userAppId"]},"DeleteRole":{"properties":{"realm":{"type":"string","x-beamable-semantic-type":"Pid"},"role":{"type":"string"}},"additionalProperties":false,"title":"Delete Role","type":"object"},"RoleMapping":{"type":"object","additionalProperties":false,"properties":{"projectId":{"type":"string"},"role":{"type":"string"}},"required":["projectId","role"]},"UpdateRole":{"properties":{"cid":{"type":"string","x-beamable-semantic-type":"Cid"},"realm":{"type":"string","x-beamable-semantic-type":"Pid"},"role":{"type":"string"}},"additionalProperties":false,"title":"Update Role","type":"object"},"AvailableRolesResponse":{"properties":{"roles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"title":"Available Roles Response","type":"object","required":["roles"]},"ExternalIdentity":{"type":"object","additionalProperties":false,"properties":{"providerService":{"type":"string"},"userId":{"type":"string"},"providerNamespace":{"type":"string"}},"required":["providerService","userId","providerNamespace"]},"RealmRolesReport":{"type":"object","additionalProperties":false,"properties":{"realmName":{"type":"string"},"realmDisplayName":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["realmName","realmDisplayName","roles"]},"GamerTagAssociation":{"type":"object","additionalProperties":false,"properties":{"projectId":{"type":"string","x-beamable-semantic-type":"Pid"},"gamerTag":{"type":"integer","format":"int64","x-beamable-semantic-type":"Gamertag"}},"required":["projectId","gamerTag"]},"EmptyResponse":{"properties":{"result":{"type":"string"}},"additionalProperties":false,"title":"Empty Response","type":"object","required":["result"]},"TransferThirdPartyAssociation":{"properties":{"fromAccountId":{"type":"integer","format":"int64"},"thirdParty":{"$ref":"#/components/schemas/ThirdPartyAssociation"}},"additionalProperties":false,"title":"Transfer Third Party Association","type":"object","required":["fromAccountId","thirdParty"]},"Account":{"properties":{"inFlight":{"type":"array","items":{"$ref":"#/components/schemas/InFlightMessage"}},"createdTimeMillis":{"type":"integer","format":"int64"},"realmId":{"type":"string"},"email":{"type":"string"},"roleString":{"type":"string"},"deviceIds":{"type":"array","items":{"type":"string"}},"privilegedAccount":{"type":"boolean"},"country":{"type":"string"},"wasMigrated":{"type":"boolean"},"id":{"type":"integer","format":"int64","x-beamable-semantic-type":"AccountId"},"gamerTags":{"type":"array","items":{"$ref":"#/components/schemas/GamerTagAssociation"}},"external":{"type":"array","items":{"$ref":"#/components/schemas/ExternalIdentity"}},"language":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleMapping"}},"updatedTimeMillis":{"type":"integer","format":"int64"},"thirdParties":{"type":"array","items":{"$ref":"#/components/schemas/ThirdPartyAssociation"}},"deviceId":{"type":"string"},"userName":{"type":"string"},"heartbeat":{"type":"integer","format":"int64"},"password":{"type":"string"}},"additionalProperties":false,"title":"Account","type":"object","required":["id","gamerTags","thirdParties","createdTimeMillis","updatedTimeMillis","external","privilegedAccount"]}},"securitySchemes":{"server":{"type":"apiKey","name":"X-DE-SIGNATURE","in":"header","description":"Signed Request authentication using project secret key."},"user":{"type":"http","description":"Bearer authentication with a player access token in the Authorization header.","scheme":"bearer","bearerFormat":"Bearer <Access Token>"}}},"security":[],"externalDocs":{"description":"Beamable Documentation","url":"https://docs.beamable.com"},"openapi":"3.0.2"}