# Organization Endpoints ### List Organizations Returns all Organizations. GET /organizations #### Request Parameters | Name | Description | Param Type | Data Type | Required | | ------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------ | ---------------- | -------- | | name | Name or portion of name you would like to use for searching/filtering. | Search Query | String | False | | show_deleted | Filters organization results based on if they're deleted or not. This is useful for filtering out older deleted organizations. | Search Query | Boolean | False | | order | Specifies the order of the results. Use “asc” for ascending order, and “desc” for descending order. | Search Query | String | False | | order_by | Specifies the field of which the ordering should occur. For example, “name”, “url_slug”, etc. | Search Query | String | False | | offset | Used to specify where to start a query. | Search Query | Integer (String) | False | | limit | Used to specify the “page size” of the query. | Search Query | Integer (String) | False |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations?show_deleted=false" ```
Response Example ```json [ { "description": null, "id": "aa49ea9a-3925-4f6f-86e4-6825ffe1ed24", "name": "Acme Org", "url_slug": "acme-org", "website": null }, { "description": null, "id": "786904d3-6a19-4af2-8bfc-5479a1010961", "name": "Acme Training Group", "url_slug": "remote-training", "website": null } ] ``` ```bash Status: 200 OK ```
--- ### List Organization Details Returns information about your customer entity. GET /organizations/:organization_id
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/" ```
Response Example ```json { "description": null, "id": "2fb210e0-e931-4c62-83fd-b31fe13468ca", "name": "Chuck's Organization", "url_slug": "example-org", "website": null } ``` ```bash Status: 200 OK ```
--- ### List Organization Audit Trails Returns Audit Trails for an account, constrained by a date range and a number of ways to filter & search for granular queries. GET /organizations/:organization_id/audit-trails #### Request Parameters | Name | Description | Param Type | Data Type | Required | | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------- | -------- | | organization_id | Your Frame Organization ID | URL | String | True | | search | Filters results if the provided string matches against a user's full name, email, idp, or the Audit Trail kind. | Search Query | String | False | | kind | Filters Audit Trails by wildcard matching against the supplied string. For example, a kind of “launchpad” will return Audit Trails for both createLaunchpad and updateLaunchpad actions. | Search Query | String | False | | from_date | The beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”. | Search Query | ISO 8601 UTC String | False | | to_date | The ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”. | Search Query | ISO 8601 UTC String | False | | offset | Used to specify where to start a Audit Trails query. **Must be used in conjunction with the limit parameter**. | Search Query | Integer (String) | False | | limit | Used to specify the “page size” of the Audit Trails query. **Must be used in conjunction with the offset parameter**. | Search Query | Integer (String) | False | | order | Specifies the order of the results. Use “asc” for ascending order, and “desc” for descending order. | Search Query | String | False | | order_by | Specifies the field of which the ordering should occur. For example, “session_start”, “session_duration”, etc. | Search Query | String | False |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/audit-trails?search=jason.thompson@nutanix.com&kind=launchpad&limit=5&offset=0&from_date=${from_date}&to_date=${to_date}&order_by=inserted_at&order=desc" ```
Response Example ```json [ { "id": "7c3dee57-5a7b-4211-a55d-7d5b8e5f595b", "user_first_name": "Jason", "user_last_name": "Thompson", "user_idp": "example-idp-name", "user_email": "jason.thompson@nutanix.com", "kind": "updateLaunchpad", "account_id": "b00636bf-4f08-404e-a7ba-3c2aaa173335", "organization_id": "86bcea89-389f-496a-3c75-1df0ce8d96ca", "customer_id": "b3e7d4e0-5ab2-43cf-9f9c-0c02909931e1", "inserted_at": "2021-10-15T20:49:13.377350Z" }, { "id": "4f62a8e4-1ab4-430b-9f4f-96fa77ff24f5", "user_first_name": "Jason", "user_last_name": "Thompson", "user_idp": "example-idp-name", "user_email": "jason.thompson@nutanix.com", "kind": "createLaunchpad", "account_id": "b00636bf-4f08-404e-a7ba-3c2aaa173335", "organization_id": "86bcea89-389f-496a-3c75-1df0ce8d96ca", "customer_id": "b3e7d4e0-5ab2-43cf-9f9c-0c02909931e1", "inserted_at": "2021-10-15T20:49:09.833114Z" } // ... more Audit Trails ] ``` ```bash Status: 200 OK ```
--- ### List Organization Session Trails Returns Session Trails based on a specified organization, time frame, and filters. GET /organizations/:organization_id/session-trails #### Request Parameters | Name | Description | Param Type | Data Type | Required | | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------- | -------- | | organization_id | Your Frame Organization ID | URL | String | True | | search | Filters results if the provided string matches against Server ID, Session ID, email address, and a user's full name. | Search Query | String | False | | session_start | The beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”. | Search Query | ISO 8601 UTC String | False | | session_end | The ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”. | Search Query | ISO 8601 UTC String | False | | instance_type | Filters Session Trails based on a specific instance type ID. | Search Query | String | False | | pool_group_type | Filters Session Trails based on the pool group server type: sandbox, production, utility, persistent_desktop_production, persistent_desktop_shadow. | Search Query | String | False | | pool_id | Filters Session Trails based on provided instance type's pool ID. | Search Query | String | False | | offset | Used to specify where to start a Session Trails query. **Must be used in conjunction with the limit parameter**. | Search Query | Integer (String) | False | | limit | Used to specify the “page size” of the Session Trails query. Must be used in conjunction with the offset parameter. | Search Query | Integer (String) | False | | order | Specifies the order of the results. Use “asc” for ascending order, and “desc” for descending order. | Search Query | String | False | | order_by | Specifies the field of which the ordering should occur. For example, “session_start”, “session_duration”, etc. | Search Query | String | False |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/session-trails?limit=50&offset=0&order=desc&order_by=session_start" ```
Response Example ```json [ { "account_id": "084ab7d0-e4ca-4dea-932a-45bf33f02088", "bandwidth_kbps_avg": 15921.05, "bandwidth_kbps_max": 16128, "bandwidth_kbps_min": 14024, "city": "Tehama", "client_ip": "123.32.145.255", "customer_id": "b3e7d4e0-5ab2-43cf-9f9c-0c02909931e1", "distance": 2369.002238311968, "fail_description": null, "framerate_ps_avg": 19.74, "framerate_ps_max": 20, "framerate_ps_min": 10, "id": "b970ec31-ca07-48c9-8b56-4547a7b1a9f8", "instance_type": "t2.large", "latency_ms_avg": 110.36, "latency_ms_max": 132, "latency_ms_min": 106, "organization_id": "2fb210e0-e931-4c62-83fd-b31fe13468ca", "pool_group_type": "sandbox", "pool_id": "d54b760c-956a-487b-a675-e113677fe871", "pool_instance_type": { "bare_metal": null, "display_name": "Air 8GB", "gpu": "None", "id": "gateway-prod.5", "name": "t2.large", "ram": 8, "vcpu": 2 }, "server_id": "gateway-prod.5232637", "session_duration": 2391, "session_end": "2021-02-25T23:17:27.000000Z", "session_id": "gateway-prod.nMOARz25k9LDmGN0", "session_start": "2021-02-25T23:15:56.000000Z", "user_email": "example.user@company.com", "user_first_name": "Example", "user_id": "52b19f2e-c8ae-4f12-beab-f2838ce8dce9", "user_idp": "example-idp", "user_last_name": "User" } ] ``` ```bash Status: 200 OK ```
--- ### List Organization API Authorization Rules Returns all Organization-level API keys that have been generated and their associated permissions. GET /organizations/:organization_id/api_authorization_rules
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/api_authorization_rules" ```
Response Example ```json [ { "api_authorization_id": "e8d5f1f0-2e4d-4362-9002-a5c11da1ffc9", "credentials": [ { "client_id": "ed1147f0-3d3e-4629-a8a5-9cc67053518c.img.frame.nutanix.com", "name": "Development Server" } ], "id": 980, "name": "Chuck's customized admin roles", "roles": [ { "id": "871dbc2d-f55f-4f15-ab4a-eb14541da4de", "role": { "applicable_on": "organization", "category": null, "description": null, "id": "6498134a-df89-4548-be2d-86b01fac91c9", "name": "Organization Administrator", "permissions": [ "cpanel_mutation_restore_backup", "cpanel_mutation_check_cluster_create_limits", "cpanel_acknowledge_notification", "cpanel_mutation_move_launchpad" // ... more permissions ] } } // ... more roles if available ] } ] ``` ```bash Status: 200 OK ```
--- ### List Organization Roles Returns available roles and associated permission granted for the specified Organization. GET /organizations/:organization_id/roles #### Request Parameters | Name | Description | Param Type | Data Type | Required | | --------------- | ---------------------------------------------------- | ------------ | --------- | -------- | | organization_id | Your Frame Organization ID | URL | String | True | | category | Filters the results by the role category, e.g. "api" | Search Query | String | True |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/roles?category="api" ```
Response Example ```json [ { "applicable_on": "account", "category": "api", "description": null, "id": "f1147b3ta-f927-46aa-66ea-6eea8569663b", "name": "API - Generate Anonymous Account Token", "permissions": ["create_anonymous_access_token"] } ] ``` ```bash Status: 200 OK ```
--- ### List Organization Cloud Services Returns a list of [registered Cloud Service Providers](/books/platform-administrators-guide/page/bring-your-own) configured with Frame for a specified Organization. GET /organizations/:organization_id/cloud_services #### Request Parameters | Parameter | Description | Param Type | Data Type | Required | | ----------------- | --------------------------------------------------------------- | ------------ | --------- | -------- | | organization_id | Your Frame Organization ID. | URL | String | True | | cloud_provider_id | The Frame cloud provider ID. | Search Query | String | true | | active | Lists cloud services based on their “active” status. | Search Query | Boolean | False | | omit_default | If true, omits Frame's default Cloud Services from the results. | Search Query | Boolean | False |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/cloud_services?active=true" ```
Response Example ```json [ { "active": true, "cloud_account_id": "199955555555", "cloud_provider_display_name": "AWS", "cloud_provider_id": "gateway-prod.2", "cloud_provider_name": "amazon", "context": "organization", "creation_date": "2019-06-11T20:25:33Z", "datacenters": [], "display_name": "Example Account", "external_id": null, "gateway": "gateway-prod", "id": "gateway-prod.459", "is_default": false, "is_provider_default": false, "name": "Example Account", "owner_id": "b3e7d4e0-5ab2-43cf-9f9c-0c02909931e1", "properties": { "cloud_account_id": "199955555555" }, "status": "ready", "supported_datacenter_ids": null, "supported_types": ["frame-high"] } ] ``` ```bash Status: 200 "OK" ```
--- ### List Organization Elasticity Returns information on all customer instance elasticity. GET /organizations/:organization_id/elasticity #### Request Parameters | Name | Description | Param Type | Data Type | Required | | --------------- | --------------------------- | ---------- | --------- | -------- | | organization_id | Your Frame Organization ID. | URL | String | True |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/elasticity ```
Response Example ```json { "buffer_servers": 10, "max_servers": 150, "min_servers": 100 } ``` ```bash Status: 200 OK ```
--- ### List Organization Settings Returns all customer entity settings. GET /organizations/:organization_id/settings
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/settings" ```
Response Example ```json { "authorized_nutanix_personnel": [ "jason.thompson@nutanix.com", "alex.fontaine@nutanix.com", "stuart.allen@nutanix.com" ], "can_frame_account_support_start_session": null, "frame_cloud_account_allowed": false, "frame_support_admin_access": "full_access", "is_frame_support_customer_admin": true, "is_generate_session_report_enabled": false, "is_light_publish_enabled": false, "is_login_banner_enabled": false, "is_persistent_desktops_backups_enabled": true, "is_terminal_banner_enabled": false, "light_publish_settings": { "threshold": 10 }, "login_banner_settings": null, "max_concurrency": 160, "max_concurrency_per_account": null, "max_monthly_credits_usage": null, "max_monthly_credits_usage_description": null, "max_utility_pools_per_account": 50, "note": null, "notification_center_settings": { "email_addresses": null, "is_send_notification_emails_enabled": null, "notify_on_critical": null, "notify_on_info": null, "notify_on_warning": null }, "terminal_banner_settings": null } ``` ```bash Status: 200 OK ```
--- ### List Organization Overall Usage Returns instance usage for the specified Organization constrained by a date range. GET /organizations/:organization_id/usage #### Request Parameters | Name | Description | Param Type | Data Type | Required | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------- | -------- | | organization_id | Your Frame Organization ID | URL | String | True | | from_date | The beginning date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”. | Search Query | ISO 8601 UTC String | False | | to_date | The ending date range for the query. The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”. | Search Query | ISO 8601 UTC String | False | | resolution_type | Resolution Type: `by_hour`, `by_day`, `by_month`, `by_year` | Search Query | String | False | | server_type | Filters query based on a specific server ID. | Search Query | String | False | | pool_id | Filters query based on provided instance type's pool ID. | Search Query | String | False | | instance_type_id | Filters the usage by an instance type's “external” ID, e.g. “gateway-prod.3”. | Search Query | String | False | | datacenter_id | Limits the results to a specific Datacenter by ID. | Search Query | String | False | | skip_if_byo_account | True/False boolean value determining if BYO results should be returned. | Search Query | Boolean | False |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/usage?from_date=${from_date}&to_date=${to_date}&server_type=production" ```
Response Example ```json { "data": [ { "account": null, "account_external_id": "gateway-prod.35917", "usage": [ { "datacenter": null, "datacenter_id": "gateway-prod.1", "hours_used": 1, "instance_type": null, "instance_type_id": "gateway-prod.3152", "server_type": "production", "time": 1626454800000 } // ... more usage data ] } // ... more accounts and usage ], "total": 43533 } ``` ```bash Status: 200 OK ```
--- ### List Organization Disk Volume Usage Returns disk volume usage statistics for specified Organization within a specified date range. GET /organizations/:organization_id/disk_volume_usage?from_date=X&to_date=Y&server #### Request Parameters | Name | Description | Param Type | Data Type | Required | | ------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------- | -------- | | organization_id | Your Frame Organization ID. | URL | String | True | | from_date | The beginning date range for the query. | The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”. | YYYY-MM-DD Date string | False | | to_date | The ending date range for the query. | The date needs to be an ISO 8601 UTC string (with the “Z” suffix). For example: “2021-12-25T23:20:58.128Z”. | YYYY-MM-DD Date string | False | | resolution_type | Resolution Type: `by_hour`, `by_day`, `by_month`, `by_year` | Search Query | String | False | | server_type | Server Type: `sandbox`, `production`, `utility`, `persistent_desktop_production`, `persistent_desktop_shadow` | Search Query | String | False | | disk_volume_type_id | Disk Volume Type: `all`, `standard`, `gp2`, `io1` | Search Query | String | False | | datacenter_id | Limits the results to a specific Datacenter ID number. | Search Query | String | False | | skip_if_byo_account | True/False boolean value determining if BYO results should be returned. | Search Query | Boolean | False |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/disk_volume_usage?from_date=${from_date}&to_date=${to_date}" ```
Response Example ```json { "data": [ { "account": null, "account_external_id": "gateway-prod.1791", "usage": [ { "datacenter": null, "datacenter_id": "gateway-prod.3", "disk_volume_size_used": 180, "disk_volume_type_id": "gp2", "hours_used": 36, "time": 1625101200000 } // ... more usage data for this account ] } // ... more accounts and their usage ], "total": 758884 } ``` ```bash Status: 200 OK ```
--- ### List Organization Master Images Returns Maser or "Gold" Image information for the specified Organization for a specified datacenter. GET /organizations/:organization_id/cloud_services/:external_cloud_service_id/master_images?external_data_center_id=XYZ #### Request Parameters | Parameter | Description | Param Type | Data Type | Required | | ----------------------- | ---------------------------------------------------- | ------------ | --------- | -------- | | external_data_center_id | This ID represents a Frame “external” datacenter ID. | Search Query | String | False |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/cloud_services/${external_cloud_service_id}/master_images?external_data_center_id=${external_data_center_id}" ```
Response Example ```json [ { "description": "Frame Master Image mif:1, v:0, date:2020-01-28 09:30:10", "id": "gateway-prod.15474", "instance_types": [ { "display_name": "Air 4GB", "external_id": "gateway-prod.1", "gpu": "None", "id": "gateway-prod.1", "name": "t2.medium", "ram": 4, "vcpu": 2 } "machine_image_family": { "display_name": "Windows Server 2016 (G4)", "id": "gateway-prod.xxx", "name": "FrameAWSWindows20126G4" }, "master_image_copy_required": null ] }, // ... more master images ] ``` ```bash Status: 200 OK ```
--- ### List Organization User Activity Returns statistical user activity information for the specified Customer constrained by a date range. Can be ordered by passing a string parameter as well as exclude specified user IDPs. GET /organizations/:organization_id/user_activities?from_date=X&to_date=Y #### Request Parameters | Name | Description | Param Type | Data Type | Required | | --------------- | -------------------------------------------------------------------------------------------------------------- | ------------ | ---------------------- | -------- | | organization_id | Your Frame Organization ID | URL | String | True | | from_date | The beginning date range for the query. | Search Query | YYYY-MM-DD Date string | True | | to_date | The ending date range for the query. | Search Query | YYYY-MM-DD Date string | True | | order | Specifies the order of the results. Use “asc” for ascending order, and “desc” for descending order. | Search Query | String | False | | order_by | Specifies the field of which the ordering should occur. For example, “session_start”, “session_duration”, etc. | Search Query | String | False | | skip_user_idps | User Identity Providers to skip. | Search Query | Array (String) | False |
Request Example ```bash curl -X GET \ -H "X-Frame-ClientId: ${client_id}" \ -H "X-Frame-Timestamp: ${timestamp}" \ -H "X-Frame-Signature: ${signature}" \ "https://api.console.nutanix.com/v1/organizations/${organization_id}/user_activities?from_date=${from_date}&to_date=${to_date}&skip_user_idps[]=example-okta-admins&skip_user_idps[]=example-okta-dev" ```
Response Example ```json { "data": [ { "access_date": "2022-02-01", "access_datetime": "2022-02-01T21:11:00.398870Z", "account_id": "0e52b11b-23bf-411e-a070-bc0ea014cbc2", "customer_id": "6ba31e38-1735-4274-a58e-6fb8c662e425", "organization_id": "bc24563d-375b-49fb-8f15-1682b8bc6deb", "user_email": "dontcallme.shirley@example.com", "user_first_name": "Shirley", "user_id": "20acd3a2-b455-4dca-b22b-520e16079e11", "user_idp": "example-okta-workforce", "user_last_name": "Dontcallme" } // ... many more User Activities ], "total": 66866, "total_unique": 8133 } ``` ```bash Status: 200 OK ```