Skip to content

org.md

Latest commit

 

History

History
540 lines (381 loc) · 18.1 KB

org.md

File metadata and controls

540 lines (381 loc) · 18.1 KB

Org Actions

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

Contents

Delete

Deletes an organization

result = client.org.delete(orgId=my_org_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.Organization, all.User, org.*, or org.delete.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Success If organization was successfully deleted

Error Responses

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

Device Counts

Returns device counts by day for the time range specified for this organization

result = client.org.device_counts(orgId=my_org_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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.deviceCounts.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
start string N Start of range for device count query (ms since epoch) 0
end string N End of range for device count query (ms since epoch) 1465790400000
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Device Counts Device counts by day

Error Responses

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

Get

Retrieves information on an organization

result = client.org.get(orgId=my_org_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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.get.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
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
200 Organization Organization information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization not found

Invite Member

Invites a person to an organization

result = client.org.invite_member(
    orgId=my_org_id,
    invite=my_invite)

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.Organization, all.User, org.*, or org.inviteMember.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
invite Organization Invitation Post Y Object containing new invite info Organization Invitation Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Organization Invitations Invitation information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization not found

Modify Member

Modifies a current org member's role

result = client.org.modify_member(
    orgId=my_org_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.Organization, all.User, org.*, or org.modifyMember.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
member Organization Member Patch Y Object containing new member pair Organization Member Patch 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
200 Organization Updated organization information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization not found

Notebook Minute Counts

Returns notebook execution usage by day for the time range specified for this organization

result = client.org.notebook_minute_counts(orgId=my_org_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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.notebookMinuteCounts.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
start string N Start of range for notebook execution query (ms since epoch) 0
end string N End of range for notebook execution query (ms since epoch) 1465790400000
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Notebook Minute Counts Notebook usage information

Error Responses

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

Patch

Updates information about an organization

result = client.org.patch(
    orgId=my_org_id,
    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.Organization, all.User, org.*, or org.patch.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
organization Organization Patch Y Object containing new organization properties Organization Patch 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
200 Organization Updated organization information

Error Responses

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

Payload Counts

Returns payload counts for the time range specified for all applications this organization owns

result = client.org.payload_counts(orgId=my_org_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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCounts.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
start string N Start of range for payload count query (ms since epoch) 0
end string N End of range for payload count query (ms since epoch) 1465790400000
asBytes string N If the resulting stats should be returned as bytes false true
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Payload Stats Payload counts, by type and source

Error Responses

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

Payload Counts Breakdown

Returns payload counts per resolution in the time range specified for all application this organization owns

result = client.org.payload_counts_breakdown(orgId=my_org_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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCountsBreakdown.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
start string N Start of range for payload count query (ms since epoch) 0
end string N End of range for payload count query (ms since epoch) 1465790400000
resolution string N Resolution in milliseconds. Accepted values are: 86400000, 3600000 86400000 86400000
asBytes string N If the resulting stats should be returned as bytes false true
includeNonBillable string N If non-billable payloads should be included in the result false true
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Payload Counts Breakdown Sum of payload counts by date

Error Responses

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

Pending Invites

Gets the current pending invites

result = client.org.pending_invites(orgId=my_org_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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.pendingInvites.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Organization Invitations Invitation information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization not found

Remove Member

Removes a member from the org

result = client.org.remove_member(
    orgId=my_org_id,
    userId=my_user_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.Organization, all.User, org.*, or org.removeMember.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
userId string Y Id of user to remove 575ed70c7ae143cd83dc4aa9
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
200 Organization Updated organization information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization not found

Revoke Invite

Revokes an existing invite

result = client.org.revoke_invite(
    orgId=my_org_id,
    inviteId=my_invite_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.Organization, all.User, org.*, or org.revokeInvite.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
inviteId string Y Id of invite to revoke 575ed71e7ae143cd83dc4aaa
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Organization Invitations Invitation information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization not found

Transfer Resources

Moves resources to a new owner

result = client.org.transfer_resources(
    orgId=my_org_id,
    transfer=my_transfer)

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.Organization, all.User, org.*, or org.transferResources.

Available Parameters

Name Type Required Description Default Example
orgId string Y ID associated with the organization 575ed6e87ae143cd83dc4aa8
transfer Resource Transfer Y Object containing properties of the transfer Resource Transfer Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Success If resource transfer was successful

Error Responses

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