Vulos Documentation
  • Identity
    • Welcome to the Vulos Identity Documentation!
    • Quick Start
    • Organizations
    • Scopes and Claims
  • Reference
    • Identity JavaScript SDK
      • The Base Package
        • KYC
          • KycStatus
          • KycInstance
          • KycDetails
          • KycApi
        • Profile
          • UserReference
          • ProfileApi
        • Cache
        • Authentication
          • Application
          • BaseAuth
          • User
          • UserInfo
          • BaseApi
        • Organizations
          • Organization
          • OrganizationMembership
            • OrganizationMembershipWithMetadata
          • OrganizationRole
          • OrganizationApi
      • The Backend Auth Package
        • CodeVerifier
        • BackendAuth
      • The Frontend Auth Package
        • IFrameRefresh
        • StateVerifier
        • FrontendAuth
    • Organization API
      • Organizations
      • Memberships
        • Roles
    • Profile API
    • KYC API
Powered by GitBook
On this page
  • Create Organization
  • Organization List
  • Organization Info
  • Update Organization
  • Delete Organization
  1. Reference
  2. Organization API

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

{ organizationId: 1, membershipId: "<guid>", userId: "<guid>" }
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

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

[
    { organizationId: 1, membershipId: "<guid>", userId: "<guid>" },
    { organizationId: 2, membershipId: "<guid>", userId: "<guid>" },
]
{
    "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

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

{
     "success": true,
     "message": "A message describing the successful response"
}
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}

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

{
     "success": true,
     "message": "A message describing the successful response"
}
{
    "error": "Something went wrong",
    "code": "<errror code>",
    "request": "<request id>"
}
PreviousOrganization APINextMemberships

Last updated 3 years ago