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

Name	Type	Description
id*	String	The user's ID

Headers

Name	Type	Description
Authorization*	String	Bearer authentication with the access token obtained using OpenID Connect

400: Bad Request Error response

{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

401: Unauthorized Empty body

200: OK The user's public profile

{
    "firstName": "John",
    "lastName": "Doe"
}

Organization Profile

GET https://identity.vulos.io/api/v1/profile/organization/:id

Get the organization's public profile information.

Path Parameters

Name	Type	Description
id*	String	The ID of the organization

Headers

Name	Type	Description
Authorization*	String	Bearer authentication with the access token obtained using OpenID Connect

200: OK The organization's public profile

{
    "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>"
}

400: Bad Request Error response

{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

401: Unauthorized Empty body

Search Organizations

GET https://identity.vulos.io/api/v1/profile/organization/search/:search/:amount/:offset

Search for an organization by name.

Path Parameters

Name	Type	Description
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

Name	Type	Description
Authorization*	String	Bearer authentication with the access token obtained using OpenID Connect

200: OK An array of organization profiles with an ID

[
    {
        "id": 1,
        "name": "Example"
        // additional public profile data
    },
    {
        "id": 2,
        "name": "Scond Example"
    }
]

400: Bad Request Empty body

401: Unauthorized Empty body