Skip to content

Latest commit

 

History

History
844 lines (599 loc) · 31.1 KB

UserApi.md

File metadata and controls

844 lines (599 loc) · 31.1 KB
Raw

wavefront_api_client.UserApi

All URIs are relative to https://YOUR_INSTANCE.wavefront.com

Method HTTP request Description
add_user_to_user_groups POST /api/v2/user/{id}/addUserGroups Adds specific groups to the user or service account
create_user POST /api/v2/user Creates an user if the user doesn't already exist.
delete_multiple_users POST /api/v2/user/deleteUsers Deletes multiple users or service accounts
delete_user DELETE /api/v2/user/{id} Deletes a user or service account identified by id
get_all_users GET /api/v2/user Get all users
get_user GET /api/v2/user/{id} Retrieves a user by identifier (email address)
get_user_business_functions GET /api/v2/user/{id}/businessFunctions Returns business functions of a specific user or service account.
grant_permission_to_users POST /api/v2/user/grant/{permission} Grants a specific permission to multiple users or service accounts
grant_user_permission POST /api/v2/user/{id}/grant Grants a specific permission to user or service account
invite_users POST /api/v2/user/invite Invite users with given user groups and permissions.
remove_user_from_user_groups POST /api/v2/user/{id}/removeUserGroups Removes specific groups from the user or service account
revoke_permission_from_users POST /api/v2/user/revoke/{permission} Revokes a specific permission from multiple users or service accounts
revoke_user_permission POST /api/v2/user/{id}/revoke Revokes a specific permission from user or service account
update_user PUT /api/v2/user/{id} Update user with given user groups, permissions and ingestion policy.
validate_users POST /api/v2/user/validateUsers Returns valid users and service accounts, also invalid identifiers from the given list

add_user_to_user_groups

UserModel add_user_to_user_groups(id, body=body)

Adds specific groups to the user or service account

Note: Applies only to original Tanzu Observability instances that are not onboarded to VMware Cloud services.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = [wavefront_api_client.list[str]()] # list[str] | The list of groups that should be added to the account (optional)

try:
    # Adds specific groups to the user or service account
    api_response = api_instance.add_user_to_user_groups(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->add_user_to_user_groups: %s\n" % e)

Parameters

Name Type Description Notes
id str
body list[str] The list of groups that should be added to the account [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

create_user

UserModel create_user(send_email=send_email, body=body)

Creates an user if the user doesn't already exist.

Note: Applies only to original Tanzu Observability instances that are not onboarded to VMware Cloud services.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
send_email = true # bool | Whether to send email notification to the user, if created.  Default: false (optional)
body = wavefront_api_client.UserToCreate() # UserToCreate | Example Body:  <pre>{   \"emailAddress\": \"[email protected]\",   \"groups\": [     \"user_management\"   ],   \"userGroups\": [     \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"   ],   \"roles\": [     \"Role\"   ], }</pre> (optional)

try:
    # Creates an user if the user doesn't already exist.
    api_response = api_instance.create_user(send_email=send_email, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->create_user: %s\n" % e)

Parameters

Name Type Description Notes
send_email bool Whether to send email notification to the user, if created. Default: false [optional]
body UserToCreate Example Body: <pre>{ &quot;emailAddress&quot;: &quot;[email protected]&quot;, &quot;groups&quot;: [ &quot;user_management&quot; ], &quot;userGroups&quot;: [ &quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090&quot; ], &quot;roles&quot;: [ &quot;Role&quot; ], }</pre> [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

delete_multiple_users

ResponseContainerListString delete_multiple_users(body=body)

Deletes multiple users or service accounts

Note: For original Tanzu Observability instances, applies to user accounts and service accounts. For Tanzu Observability instances that are onboarded to VMware Cloud services, applies only to service accounts.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
body = [wavefront_api_client.list[str]()] # list[str] | identifiers of list of users which should be deleted (optional)

try:
    # Deletes multiple users or service accounts
    api_response = api_instance.delete_multiple_users(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->delete_multiple_users: %s\n" % e)

Parameters

Name Type Description Notes
body list[str] identifiers of list of users which should be deleted [optional]

Return type

ResponseContainerListString

Authorization

api_key

HTTP request headers

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

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

delete_user

delete_user(id)

Deletes a user or service account identified by id

Note: For original Tanzu Observability instances, applies to user accounts and service accounts. For Tanzu Observability instances that are onboarded to VMware Cloud services, applies only to service accounts.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Deletes a user or service account identified by id
    api_instance.delete_user(id)
except ApiException as e:
    print("Exception when calling UserApi->delete_user: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

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

get_all_users

list[UserModel] get_all_users()

Get all users

Note: Applies only to original Tanzu Observability instances that are not onboarded to VMware Cloud services.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))

try:
    # Get all users
    api_response = api_instance.get_all_users()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->get_all_users: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[UserModel]

Authorization

api_key

HTTP request headers

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

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

get_user

UserModel get_user(id)

Retrieves a user by identifier (email address)

Note: Applies only to original Tanzu Observability instances that are not onboarded to VMware Cloud services.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Retrieves a user by identifier (email address)
    api_response = api_instance.get_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->get_user: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

get_user_business_functions

UserModel get_user_business_functions(id)

Returns business functions of a specific user or service account.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Returns business functions of a specific user or service account.
    api_response = api_instance.get_user_business_functions(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->get_user_business_functions: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

grant_permission_to_users

UserModel grant_permission_to_users(permission, body=body)

Grants a specific permission to multiple users or service accounts

Note: For original Tanzu Observability instances, applies to user accounts and service accounts. For Tanzu Observability instances that are onboarded to VMware Cloud services, applies only to service accounts.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
permission = 'permission_example' # str | Permission to grant to the users. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission
body = [wavefront_api_client.list[str]()] # list[str] | List of users which should be granted by specified permission (optional)

try:
    # Grants a specific permission to multiple users or service accounts
    api_response = api_instance.grant_permission_to_users(permission, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->grant_permission_to_users: %s\n" % e)

Parameters

Name Type Description Notes
permission str Permission to grant to the users. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission
body list[str] List of users which should be granted by specified permission [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

grant_user_permission

UserModel grant_user_permission(id, group=group)

Grants a specific permission to user or service account

Note: For original Tanzu Observability instances, applies to user accounts and service accounts. For Tanzu Observability instances that are onboarded to VMware Cloud services, applies only to service accounts.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
group = 'group_example' # str | Permission group to grant to the account. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission (optional)

try:
    # Grants a specific permission to user or service account
    api_response = api_instance.grant_user_permission(id, group=group)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->grant_user_permission: %s\n" % e)

Parameters

Name Type Description Notes
id str
group str Permission group to grant to the account. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

invite_users

UserModel invite_users(body=body)

Invite users with given user groups and permissions.

Note: Applies only to original Tanzu Observability instances that are not onboarded to VMware Cloud services.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
body = [wavefront_api_client.UserToCreate()] # list[UserToCreate] | Example Body:  <pre>[ {   \"emailAddress\": \"[email protected]\",   \"groups\": [     \"user_management\"   ],   \"userGroups\": [     \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"   ],   \"roles\": [     \"Role\"   ], } ]</pre> (optional)

try:
    # Invite users with given user groups and permissions.
    api_response = api_instance.invite_users(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->invite_users: %s\n" % e)

Parameters

Name Type Description Notes
body list[UserToCreate] Example Body: <pre>[ { &quot;emailAddress&quot;: &quot;[email protected]&quot;, &quot;groups&quot;: [ &quot;user_management&quot; ], &quot;userGroups&quot;: [ &quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090&quot; ], &quot;roles&quot;: [ &quot;Role&quot; ], } ]</pre> [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

remove_user_from_user_groups

UserModel remove_user_from_user_groups(id, body=body)

Removes specific groups from the user or service account

Note: Applies only to original Tanzu Observability instances that are not onboarded to VMware Cloud services.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = [wavefront_api_client.list[str]()] # list[str] | The list of groups that should be removed from the account (optional)

try:
    # Removes specific groups from the user or service account
    api_response = api_instance.remove_user_from_user_groups(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->remove_user_from_user_groups: %s\n" % e)

Parameters

Name Type Description Notes
id str
body list[str] The list of groups that should be removed from the account [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

revoke_permission_from_users

UserModel revoke_permission_from_users(permission, body=body)

Revokes a specific permission from multiple users or service accounts

Note: For original Tanzu Observability instances, applies to user accounts and service accounts. For Tanzu Observability instances that are onboarded to VMware Cloud services, applies only to service accounts.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
permission = 'permission_example' # str | Permission to revoke from the accounts. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission
body = [wavefront_api_client.list[str]()] # list[str] | List of users or service accounts which should be revoked by specified permission (optional)

try:
    # Revokes a specific permission from multiple users or service accounts
    api_response = api_instance.revoke_permission_from_users(permission, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->revoke_permission_from_users: %s\n" % e)

Parameters

Name Type Description Notes
permission str Permission to revoke from the accounts. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission
body list[str] List of users or service accounts which should be revoked by specified permission [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

revoke_user_permission

UserModel revoke_user_permission(id, group=group)

Revokes a specific permission from user or service account

Note: For original Tanzu Observability instances, applies to user accounts and service accounts. For Tanzu Observability instances that are onboarded to VMware Cloud services, applies only to service accounts.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
group = 'group_example' # str |  (optional)

try:
    # Revokes a specific permission from user or service account
    api_response = api_instance.revoke_user_permission(id, group=group)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->revoke_user_permission: %s\n" % e)

Parameters

Name Type Description Notes
id str
group str [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

update_user

UserModel update_user(id, body=body)

Update user with given user groups, permissions and ingestion policy.

Note: Applies only to original Tanzu Observability instances that are not onboarded to VMware Cloud services.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = wavefront_api_client.UserRequestDTO() # UserRequestDTO | Example Body:  <pre>{   \"identifier\": \"[email protected]\",   \"groups\": [     \"user_management\"   ],   \"userGroups\": [     \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"   ],   \"roles\": [     \"Role\"   ] }</pre> (optional)

try:
    # Update user with given user groups, permissions and ingestion policy.
    api_response = api_instance.update_user(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->update_user: %s\n" % e)

Parameters

Name Type Description Notes
id str
body UserRequestDTO Example Body: <pre>{ &quot;identifier&quot;: &quot;[email protected]&quot;, &quot;groups&quot;: [ &quot;user_management&quot; ], &quot;userGroups&quot;: [ &quot;8b23136b-ecd2-4cb5-8c92-62477dcc4090&quot; ], &quot;roles&quot;: [ &quot;Role&quot; ] }</pre> [optional]

Return type

UserModel

Authorization

api_key

HTTP request headers

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

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

validate_users

ResponseContainerValidatedUsersDTO validate_users(body=body)

Returns valid users and service accounts, also invalid identifiers from the given list

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.UserApi(wavefront_api_client.ApiClient(configuration))
body = [wavefront_api_client.list[str]()] # list[str] |  (optional)

try:
    # Returns valid users and service accounts, also invalid identifiers from the given list
    api_response = api_instance.validate_users(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->validate_users: %s\n" % e)

Parameters

Name Type Description Notes
body list[str] [optional]

Return type

ResponseContainerValidatedUsersDTO

Authorization

api_key

HTTP request headers

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

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