Skip to main content

Organizations

The token's organization: name, time zone, monthly cost cap and custom_metadata.

CommandHTTPDescription
organizations listGET /v1/organizationsList organizations
organizations getGET /v1/organizations/{id}Get organization details
organizations updatePATCH /v1/organizations/{id}Update the token's organization
organizations slack-installations listGET /v1/organizations/{id}/slack_installationsSlack bot installations of the organization
organizations slack-installations updatePATCH /v1/organizations/{id}/slack_installations/{installationId}Configures a Slack installation
organizations slack-installations deleteDELETE /v1/organizations/{id}/slack_installations/{installationId}Removes a Slack installation

Examples​

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits the fields that come back — worth using on every list/get to save context. See Global flags for the full reference.

# List organizations
kobana kadu organizations list --fields "id"

# Get organization details
kobana kadu organizations get --params '{"id": "ORGANIZATION_ID"}'

# Update the token's organization
kobana kadu organizations update --params '{"id": "ORGANIZATION_ID"}'

# Slack bot installations of the organization
kobana kadu organizations slack-installations list \
--params '{"id": "ORGANIZATION_ID"}'

# Configures a Slack installation
kobana kadu organizations slack-installations update \
--params '{"id": "ORGANIZATION_ID", "installationId": "INSTALLATION_ID"}'

# Removes a Slack installation
kobana kadu organizations slack-installations delete \
--params '{"id": "ORGANIZATION_ID", "installationId": "INSTALLATION_ID"}' \
--dry-run

Next steps​