Console Connect logo

Companies

Manage Company business and network information.

Create a company

Securityapi-key
Request
Request Body schema: application/json
any (CompanyModel)
Responses
200

OK

put/api/company
Request samples
application/json
{
  • "name": "Foo International",
  • "businessRegistrationNumber": "EXAMPLE-321",
  • "company": {
    }
}

Remove role from user

Remove a role from a user within a given company.

Securityapi-key
Request
path Parameters
username
required
string

The username of the company to join.

Example: acmeinc
targetUsername
required
string

The username of the user to respond to.

Example: meg
roleName
required
string

The role to apply to or remove from the user.

Example: ADMIN
Responses
200

OK

delete/api/company/{username}/memberships/{targetUsername}/roles/{roleName}

Add role to user

Add a role to a user within a given company.

Securityapi-key
Request
path Parameters
username
required
string

The username of the company to join.

Example: acmeinc
targetUsername
required
string

The username of the user to respond to.

Example: meg
roleName
required
string

The role to apply to or remove from the user.

Example: ADMIN
Responses
200

OK

put/api/company/{username}/memberships/{targetUsername}/roles/{roleName}

Update user role state

Company membership requests can be in one of the following states:

  • INACTIVE - Request made by either company or user.
  • ACTIVE - Request accepted and they are a member of the company.
  • DENIED - Request denied by the company.
  • CANCELLED - Request cancelled by either company or user.
Securityapi-key
Request
path Parameters
username
required
string

The username of the company.

Example: acmeinc
targetUsername
required
string

the username of the user to modify.

Example: meg
Request Body schema: application/json
state
string

The new state for this user; INACTIVE, ACTIVE, DENIED, or CANCELLED.

Responses
200

OK

post/api/company/{username}/memberships/{targetUsername}
Request samples
application/json
{
  • "state": "ACTIVE"
}

Remove a user from a company

Securityapi-key
Request
path Parameters
username
required
string

The username of the company.

Example: acmeinc
targetUsername
required
string

the username of the user to modify.

Example: meg
Responses
200

OK

delete/api/company/{username}/memberships/{targetUsername}
Response samples
application/json
{ }

Leave a Company

Removes the authenticated user from the company.

Securityapi-key
Request
path Parameters
username
required
string

the username of the company to leave.

Example: acmeinc
Responses
200

OK

delete/api/company/{username}/memberships
➔ Next to Users