Skip to content

Get own account​

GET
/auth/api/v1/peer-management/account

Returns the details of the signed-in user and of the user's company. A user can read only the own account. A user who is not yet approved can call this route; peerOperatingCountry, peerType, peerConnectionType, peerGroup, isPrivileged, subscriptionType and subscriptionExpiryDate are then null. peerCompanyName and irohaPubKeyHex are always present.

Authorizations​

bearerAuth

The accessToken of a sign-in or refresh answer. Valid for 5 minutes.

Type
HTTP (bearer)

Parameters​

Query Parameters

accountId

Account of the signed-in user, in the form name@company. Optional. Any other account answers 403 with code 59.

Type
string
Example"admin@example_telco"
email

Email of the signed-in user. Without it the account of the session is returned. Any other email answers 403 with code 59.

Type
string
Example"alice@example.com"
Format
"email"

Responses​

The account.

application/json
JSON
{
  
"status": {
  
  
"code": 0,
  
  
"name": "Ok"
  
},
  
"data": {
  
  
"irohaPubKeyHex": "fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210",
  
  
"peerCompanyName": "Example Telco",
  
  
"peerOperatingCountry": "GB",
  
  
"peerType": "MEDIUM_TELCO",
  
  
"peerConnectionType": "Web",
  
  
"peerGroup": null,
  
  
"isPrivileged": false,
  
  
"subscriptionType": "FREEMIUM",
  
  
"subscriptionExpiryDate": null,
  
  
"email": "alice@example.com",
  
  
"accountId": "admin@example_telco",
  
  
"authPubKeyHex": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  
  
"salt": "00112233445566778899aabbccddeeff",
  
  
"role": "ROLE_DOMAIN_ADMIN",
  
  
"status": "ACTIVE",
  
  
"phoneNumber": "+447700900123",
  
  
"firstName": "Alice",
  
  
"lastName": "Example",
  
  
"roleName": "Analyst",
  
  
"registrationDate": "2025-01-15T09:30:00Z",
  
  
"twoFactorAuthEnabled": false
  
}
}

Samples​

Powered by VitePress OpenAPI