Skip to content

Latest commit

 

History

History
214 lines (150 loc) · 11.8 KB

UsersApi.md

File metadata and controls

214 lines (150 loc) · 11.8 KB
Raw

zuora_client.UsersApi

All URIs are relative to https://rest.zuora.com

Method HTTP request Description
g_et_entities_user_accessible GET /v1/users/{username}/accessible-entities Multi-entity: Get entities that a user can access
p_ut_accept_user_access PUT /v1/users/{username}/accept-access Multi-entity: Accept user access
p_ut_deny_user_access PUT /v1/users/{username}/deny-access Multi-entity: Deny user access
p_ut_send_user_access_requests PUT /v1/users/{username}/request-access Multi-entity: Send user access requests

g_et_entities_user_accessible

GETEntitiesUserAccessibleResponseType g_et_entities_user_accessible(username, zuora_entity_ids=zuora_entity_ids)

Multi-entity: Get entities that a user can access

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves detailed information about all the entities that a user has permission to access. ## User Access Permission You can make the call as any entity user.

Example

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

# create an instance of the API class
api_instance = zuora_client.UsersApi()
username = 'username_example' # str | Specify the login user name that you want to retrieve. 
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)

try:
    # Multi-entity: Get entities that a user can access
    api_response = api_instance.g_et_entities_user_accessible(username, zuora_entity_ids=zuora_entity_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->g_et_entities_user_accessible: %s\n" % e)

Parameters

Name Type Description Notes
username str Specify the login user name that you want to retrieve.
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]

Return type

GETEntitiesUserAccessibleResponseType

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

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

p_ut_accept_user_access

PUTAcceptUserAccessResponseType p_ut_accept_user_access(username, zuora_entity_ids=zuora_entity_ids)

Multi-entity: Accept user access

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Accepts user access to an entity. ## User Access Permission You must make the calls as an administrator of the entity that you want to accept the user access to.

Example

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

# create an instance of the API class
api_instance = zuora_client.UsersApi()
username = 'username_example' # str | Specify the login name of the user that you want to accept the access request for. 
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)

try:
    # Multi-entity: Accept user access
    api_response = api_instance.p_ut_accept_user_access(username, zuora_entity_ids=zuora_entity_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->p_ut_accept_user_access: %s\n" % e)

Parameters

Name Type Description Notes
username str Specify the login name of the user that you want to accept the access request for.
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]

Return type

PUTAcceptUserAccessResponseType

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

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

p_ut_deny_user_access

PUTDenyUserAccessResponseType p_ut_deny_user_access(username, zuora_entity_ids=zuora_entity_ids)

Multi-entity: Deny user access

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Denies a user access to an entity. ## User Access Permission You must make the calls as an administrator of the entity that you want to deny the user access to.

Example

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

# create an instance of the API class
api_instance = zuora_client.UsersApi()
username = 'username_example' # str | Specify the login name of the user that you want to deny the access. 
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)

try:
    # Multi-entity: Deny user access
    api_response = api_instance.p_ut_deny_user_access(username, zuora_entity_ids=zuora_entity_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->p_ut_deny_user_access: %s\n" % e)

Parameters

Name Type Description Notes
username str Specify the login name of the user that you want to deny the access.
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]

Return type

PUTDenyUserAccessResponseType

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

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

p_ut_send_user_access_requests

PUTSendUserAccessRequestResponseType p_ut_send_user_access_requests(username, request, zuora_entity_ids=zuora_entity_ids)

Multi-entity: Send user access requests

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Sends access requests to the entities that a user wants to access. ## User Access Permission You must make the call as an administrator of the entity, in which the request user is created. Also, this administrator must have the permission to access the entities that the request user wants to access.

Example

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

# create an instance of the API class
api_instance = zuora_client.UsersApi()
username = 'username_example' # str | Specify the login name of the user who wants to access other entities. 
request = zuora_client.PUTSendUserAccessRequestType() # PUTSendUserAccessRequestType | 
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)

try:
    # Multi-entity: Send user access requests
    api_response = api_instance.p_ut_send_user_access_requests(username, request, zuora_entity_ids=zuora_entity_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->p_ut_send_user_access_requests: %s\n" % e)

Parameters

Name Type Description Notes
username str Specify the login name of the user who wants to access other entities.
request PUTSendUserAccessRequestType
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]

Return type

PUTSendUserAccessRequestResponseType

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

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