Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 3.24 KB

orgs.md

File metadata and controls

91 lines (64 loc) · 3.24 KB

Orgs Actions

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

Contents

Get

Returns the organizations associated with the current user

result = client.orgs.get(**optional_params)

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.User, all.User.read, orgs.*, or orgs.get.

Available Parameters

Name Type Required Description Default Example
sortField string N Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated name name
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name name
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*org
summaryExclude string N Comma-separated list of summary fields to exclude from org summaries payloadCount
summaryInclude string N Comma-separated list of summary fields to include in org summary payloadCount
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Organizations Collection of organizations

Error Responses

Code Type Description
400 Error Error if malformed request

Post

Create a new organization

result = client.orgs.post(organization=my_organization)

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.User, orgs.*, or orgs.post.

Available Parameters

Name Type Required Description Default Example
organization Organization Post Y New organization information Organization Post Example
summaryExclude string N Comma-separated list of summary fields to exclude from org summary payloadCount
summaryInclude string N Comma-separated list of summary fields to include in org summary payloadCount
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Organization Successfully created organization

Error Responses

Code Type Description
400 Error Error if malformed request