Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 3.14 KB

instanceMembers.md

File metadata and controls

91 lines (64 loc) · 3.14 KB

Instance Members Actions

Details on the various actions that can be performed on the Instance Members resource, including the expected parameters and the potential responses.

Contents

Get

Returns a collection of instance members

result = client.instance_members.get(instanceId=my_instance_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceMembers.*, or instanceMembers.get.

Available Parameters

Name Type Required Description Default Example
instanceId string Y ID associated with the instance 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: email, role email role
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role email
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my * instance
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Instance Members A collection of instance members

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if instance was not found

Post

Creates a new instance member

result = client.instance_members.post(
    instanceId=my_instance_id,
    member=my_member)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceMembers.*, or instanceMembers.post.

Available Parameters

Name Type Required Description Default Example
instanceId string Y ID associated with the instance 575ec8687ae143cd83dc4a97
member Instance Member Post Y Object containing new member info Instance Member Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Instance Member The newly created instance member

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if instance was not found