Organizations

Using these endpoints you can create, delete and update organizations!

Create Organization

PUT https://identity.vulos.io/api/v1/organization/create

Create a new organization.

Headers

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

Request Body

Name	Type	Description
name*	String	The name of the organization
website	String	The website of the organization
address*	String	The address where the organization is located at
uniqueId*	String	A unique identifier that the organization has been registered with (for example: an OUI)
taxNumber*	String	The organization's tax number
city*	String	The city where the organization is located at
countryCode*	String	The two-letter country code where the organization is located at
zipCode*	String	The zip / postal code where the organization is located at
state	String	The state where the organization is located at

200: OK A reference to the organization that was created

{ organizationId: 1, membershipId: "<guid>", userId: "<guid>" }

400: Bad Request Error response

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

401: Unauthorized Empty body

Organization List

GET https://identity.vulos.io/api/v1/organization/list

Get all organizations for the authenticated user.

Headers

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

401: Unauthorized Authorization failed

200: OK A list of organization memberships

[
    { organizationId: 1, membershipId: "<guid>", userId: "<guid>" },
    { organizationId: 2, membershipId: "<guid>", userId: "<guid>" },
]

400: Bad Request Invalid permissions or resource

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

Organization Info

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

Get information about a specific organization.

Path Parameters

Name	Type	Description
id*	Number	The ID of the organization

Headers

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

401: Unauthorized Empty body

200: OK Information about the organization

{
    "memberships": [
        { organizationId: 2, membershipId: "<guid>", userId: "<guid>" },
        { organizationId: 2, membershipId: "<guid>", userId: "<guid>" },
    ],
    "id": 2,
    "name": "Example Organization",
    "website": "https://example.com",
    "address": "Example Address",
    "uniqueId": "<organization unique id>",
    "taxNumber": "<organization tax number>",
    "city": "Example City",
    "country": {
        "alpha2": "AQ",
        "name": "Antartica"
    },
    "zipCode": "<organization zip code>",
    "state": "<optional state>",
    "verified": false
}

400: Bad Request Error response

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

Update Organization

PUT https://identity.vulos.io/api/v1/organization/:id/update

Update a specific organization's details.

Path Parameters

Name	Type	Description
id*	Number	The ID of the organization

Headers

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

Request Body

Name	Type	Description
name	String	The name of the organization
website	String	The website of the organization
address	String	The address where the organization is located at
uniqueId	String	A unique identifier that the organization has been registered with (for example: an OUI)
taxNumber	String	The organization's tax number
city	String	The city where the organization is located at
countryCode	Alpha 2	The two-letter country code where the organization is located at
zipCode	String	The zip / postal code where the organization is located at
state	String	The state where the organization is located at

200: OK Success message

{
     "success": true,
     "message": "A message describing the successful response"
}

400: Bad Request Error response

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

401: Unauthorized Empty body

Delete Organization

DELETE https://identity.vulos.io/api/v1/organization/:id/delete

Delete an organization.

Path Parameters

Name	Type	Description
id*	Number	The ID of the organization

Headers

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

200: OK Success message

{
     "success": true,
     "message": "A message describing the successful response"
}

400: Bad Request Error response

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

401: Unauthorized Empty body