Profile API
Get information about a specific user using this API.
If you use the JavaScript SDK you could use the ProfileApi abstraction instead.
You need the profile:read scope to access this API.
User Profile
GET https://identity.vulos.io/api/v1/profile/:id
Get the user's public profile information.
Path Parameters
id*
String
The user's ID
Headers
Authorization*
String
Bearer authentication with the access token obtained using OpenID Connect
{
"error": "Something went wrong",
"code": "<errror code>",
"request": "<request id>"
}Organization Profile
GET https://identity.vulos.io/api/v1/profile/organization/:id
Get the organization's public profile information.
Path Parameters
id*
String
The ID of the organization
Headers
Authorization*
String
Bearer authentication with the access token obtained using OpenID Connect
{
"name": "Example",
"address": "Example Address",
"city": "Example Test",
"country": "Example Country Name",
"state": "Example State Name",
"website": "https://example.com",
"verified": false,
"uniqueId": "<example unique id>",
"zipCode": "<example zip code>"
}Search Organizations
GET https://identity.vulos.io/api/v1/profile/organization/search/:search/:amount/:offset
Search for an organization by name.
Path Parameters
search*
String
The keyword to find in the organization's name
amount
String
The maximal amount of organizations to return (defaults to 10, it's limited to 100)
offset
String
The amount of organizations to skip (defaults to 0)
Headers
Authorization*
String
Bearer authentication with the access token obtained using OpenID Connect
[
{
"id": 1,
"name": "Example"
// additional public profile data
},
{
"id": 2,
"name": "Scond Example"
}
]Last updated