Invite API Docs

The Invite API allows you to manage invites to your organization. This allows you to (batch) add users to your organization and it is useful for onboarding new users.

Use Cases

• List the roles you can assign to a user.
• Invite a user.
• Delete a pending invite.
• Renew invite.
• Batch send or renew invites.
• Search pending invites.

How to use the API Docs

Use the interactive documentation to explore the Invite API endpoints. Each request will have a complete description of all the required parameters and it also allows you to instantly try it out in the online console. Code templates are also provided for you to quickly build scripts.

In the interactive explorer, the Client ID and Client Secret has been pre-filled and will allow you to make read-only API requests. These credentials will allow you to get an Access Token, which will be stored for subsequent API requests and regenerated when it expires.

Note: The interactive documentation uses read-only credentials and the try it out feature will only work with GET and selected POSTrequests.

To try other Invite API requests, go to https://visibility.amp.cisco.com/iroh/invite/index.html

Generate an Access Token

In the interactive API explorer, the Access Token is automatically generated using the pre-filled Client ID and Client Secret so you do not need to generate it yourself.

If you want to understand how the Access Token is generated from the Client ID and Client Secret credentials, take a look at the Authentication page.

For detailed instructions on how to use the interactive API documentation (or your own Python script), see the Getting Started page.

Download the Invite OpenAPI Specification

Download the Invite OpenAPI specification (OAS) file here.

Sample Code

Below is an example of how to use the Invite API.

import json
import requests

# create headers for API request (See the OAuth2 overview page for sample code to generate an access token)
access_token = 'eyJhbGciO....bPito5n5Q' # truncated example, generate JWT token separately
bearer_token = 'Bearer ' + access_token

# get the available roles
url = 'https://visibility.amp.cisco.com/iroh/invite/available-roles'

headers = {
            'Authorization': bearer_token,
            'Content-Type':'application/json',
            'Accept':'application/json'
}

response = requests.get(url, headers=headers)
print(response.text)

if response.status_code == 200:
    # convert the response to a dict object
    response_json = json.loads(response.text)

    # iterate through the list of roles
    for role in response_json:
        print(role)