Skip to content

InviteApi.md

Latest commit

 

History

History
340 lines (233 loc) · 10.6 KB

InviteApi.md

File metadata and controls

340 lines (233 loc) · 10.6 KB

hyperstack.InviteApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method HTTP request Description
accept_invite GET /auth/invites/{id}/accept Accept Invite
delete_invite DELETE /auth/invites/{id} Accept Invite
invite_user_to_organization POST /auth/invites Invite User to Organization
list_invites GET /auth/invites List Invites

accept_invite

CommonResponseModel accept_invite(id)

Accept Invite

Accept an invitation for a user to join your organization.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.common_response_model import CommonResponseModel
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.InviteApi(api_client)
    id = 56 # int | 

    try:
        # Accept Invite
        api_response = api_instance.accept_invite(id)
        print("The response of InviteApi->accept_invite:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InviteApi->accept_invite: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

CommonResponseModel

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Invite deleted successfully -
400 Bad Request -
401 Unauthorized -
404 Not Found -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_invite

CommonResponseModel delete_invite(id)

Accept Invite

Deletes an invitation for a user to join your organization. For additional information on deleting an invitation, click here.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.common_response_model import CommonResponseModel
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.InviteApi(api_client)
    id = 56 # int | 

    try:
        # Accept Invite
        api_response = api_instance.delete_invite(id)
        print("The response of InviteApi->delete_invite:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InviteApi->delete_invite: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

CommonResponseModel

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Invite accepted successfully -
400 Bad Request -
401 Unauthorized -
404 Not Found -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

invite_user_to_organization

InviteUserResponseModel invite_user_to_organization(payload)

Invite User to Organization

Invites a user to join your organization. For additional information on inviting users to the organization, click here.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.invite_user_payload import InviteUserPayload
from hyperstack.models.invite_user_response_model import InviteUserResponseModel
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.InviteApi(api_client)
    payload = hyperstack.InviteUserPayload() # InviteUserPayload | 

    try:
        # Invite User to Organization
        api_response = api_instance.invite_user_to_organization(payload)
        print("The response of InviteApi->invite_user_to_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InviteApi->invite_user_to_organization: %s\n" % e)

Parameters

Name Type Description Notes
payload InviteUserPayload

Return type

InviteUserResponseModel

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Success -
400 Bad Request -
401 Unauthorized -
409 Conflict -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_invites

GetInvitesResponseModel list_invites()

List Invites

Retrieve a list of email invitations from your organization. For additional information on listing invited users, click here.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.get_invites_response_model import GetInvitesResponseModel
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.InviteApi(api_client)

    try:
        # List Invites
        api_response = api_instance.list_invites()
        print("The response of InviteApi->list_invites:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InviteApi->list_invites: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetInvitesResponseModel

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]