Skip to content

InvitesApi.md

Latest commit

 

History

History
160 lines (115 loc) · 5.35 KB

InvitesApi.md

File metadata and controls

160 lines (115 loc) · 5.35 KB

InvitesApi

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

Method HTTP request Description
createInviteToken POST /v1/invite/tokens Create invite token
createInviteTokenWithHttpInfo POST /v1/invite/tokens Create invite token

createInviteToken

CreateInviteToken201Response createInviteToken(createInviteTokenRequest)

Create invite token

Generate a secure invite link to grant team members access to your profiles. Invites expire after 7 days and are single-use.

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.InvitesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        InvitesApi apiInstance = new InvitesApi(defaultClient);
        CreateInviteTokenRequest createInviteTokenRequest = new CreateInviteTokenRequest(); // CreateInviteTokenRequest | 
        try {
            CreateInviteToken201Response result = apiInstance.createInviteToken(createInviteTokenRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvitesApi#createInviteToken");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
createInviteTokenRequest CreateInviteTokenRequest

Return type

CreateInviteToken201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Invite token created -
400 Invalid request -
401 Unauthorized -
403 One or more profiles not found or not owned -

createInviteTokenWithHttpInfo

ApiResponse createInviteToken createInviteTokenWithHttpInfo(createInviteTokenRequest)

Create invite token

Generate a secure invite link to grant team members access to your profiles. Invites expire after 7 days and are single-use.

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.ApiResponse;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.InvitesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        InvitesApi apiInstance = new InvitesApi(defaultClient);
        CreateInviteTokenRequest createInviteTokenRequest = new CreateInviteTokenRequest(); // CreateInviteTokenRequest | 
        try {
            ApiResponse<CreateInviteToken201Response> response = apiInstance.createInviteTokenWithHttpInfo(createInviteTokenRequest);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling InvitesApi#createInviteToken");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
createInviteTokenRequest CreateInviteTokenRequest

Return type

ApiResponse<CreateInviteToken201Response>

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Invite token created -
400 Invalid request -
401 Unauthorized -
403 One or more profiles not found or not owned -