Skip to content
This repository was archived by the owner on Mar 14, 2024. It is now read-only.

MembersApi.md

Latest commit

 

History

History
509 lines (360 loc) · 15.2 KB

MembersApi.md

File metadata and controls

509 lines (360 loc) · 15.2 KB
Raw

QoveryApi.MembersApi

All URIs are relative to https://api.qovery.com

Method HTTP request Description
deleteInviteMember DELETE /organization/{organizationId}/inviteMember/{inviteId} Remove an invited member
deleteMember DELETE /organization/{organizationId}/member Remove a member
editOrganizationMemberRole PUT /organization/{organizationId}/member Edit an organization member role
getMemberInvitation GET /organization/{organizationId}/inviteMember/{inviteId} Get member invitation
getOrganizationInvitedMembers GET /organization/{organizationId}/inviteMember Get invited members
getOrganizationMembers GET /organization/{organizationId}/member Get organization members
postAcceptInviteMember POST /organization/{organizationId}/inviteMember/{inviteId} Accept Invite in the organization
postInviteMember POST /organization/{organizationId}/inviteMember Invite someone in the organization
postOrganizationTransferOwnership POST /organization/{organizationId}/transferOwnership Transfer organization ownership to another user

deleteInviteMember

deleteInviteMember(organizationId, inviteId)

Remove an invited member

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
let inviteId = "inviteId_example"; // String | Invite ID
apiInstance.deleteInviteMember(organizationId, inviteId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
inviteId String Invite ID

Return type

null (empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteMember

deleteMember(organizationId, opts)

Remove a member

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
let opts = {
  'deleteMemberRequest': new QoveryApi.DeleteMemberRequest() // DeleteMemberRequest | 
};
apiInstance.deleteMember(organizationId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
deleteMemberRequest DeleteMemberRequest [optional]

Return type

null (empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

editOrganizationMemberRole

editOrganizationMemberRole(organizationId, opts)

Edit an organization member role

Edit an organization member role

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
let opts = {
  'memberRoleUpdateRequest': new QoveryApi.MemberRoleUpdateRequest() // MemberRoleUpdateRequest | 
};
apiInstance.editOrganizationMemberRole(organizationId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
memberRoleUpdateRequest MemberRoleUpdateRequest [optional]

Return type

null (empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

getMemberInvitation

InviteMember getMemberInvitation(organizationId, inviteId)

Get member invitation

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
let inviteId = "inviteId_example"; // String | Invite ID
apiInstance.getMemberInvitation(organizationId, inviteId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
inviteId String Invite ID

Return type

InviteMember

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getOrganizationInvitedMembers

InviteMemberResponseList getOrganizationInvitedMembers(organizationId)

Get invited members

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
apiInstance.getOrganizationInvitedMembers(organizationId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID

Return type

InviteMemberResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getOrganizationMembers

MemberResponseList getOrganizationMembers(organizationId)

Get organization members

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
apiInstance.getOrganizationMembers(organizationId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID

Return type

MemberResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

postAcceptInviteMember

InviteMember postAcceptInviteMember(organizationId, inviteId)

Accept Invite in the organization

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
let inviteId = "inviteId_example"; // String | Invite ID
apiInstance.postAcceptInviteMember(organizationId, inviteId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
inviteId String Invite ID

Return type

InviteMember

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

postInviteMember

InviteMember postInviteMember(organizationId, opts)

Invite someone in the organization

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
let opts = {
  'inviteMemberRequest': new QoveryApi.InviteMemberRequest() // InviteMemberRequest | 
};
apiInstance.postInviteMember(organizationId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
inviteMemberRequest InviteMemberRequest [optional]

Return type

InviteMember

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

postOrganizationTransferOwnership

postOrganizationTransferOwnership(organizationId, opts)

Transfer organization ownership to another user

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.MembersApi();
let organizationId = "organizationId_example"; // String | Organization ID
let opts = {
  'transferOwnershipRequest': new QoveryApi.TransferOwnershipRequest() // TransferOwnershipRequest | 
};
apiInstance.postOrganizationTransferOwnership(organizationId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
transferOwnershipRequest TransferOwnershipRequest [optional]

Return type

null (empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined