Org

Load an organization

Loads an organization by UID.

  • Requires action org:Load
  • Requires action org:LoadExpired to load expired organizations
get/api/v1/org/{orgUID}

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Response

OK

active_sourcesinteger

Total number of active sources within the last 5 minutes

active_usersinteger

Total number of active users within the last 7 days (which might be active on a different org)

namestring required

Name of the organization

org_type_uidstring

Organization Type

owner_emailstring email required

The email address of the user who owns this org

owner_uidstring

The user UID who owns this organization

processing_stackstring

Deployment stack the org runs on, extracted from the org type's policy (e.g. 'saas', 'enterprise-us')

resource_namestring

Resource name utilized by RBAC

standbyboolean

Is this org in standby mode?

tagsstring[]

User supplied tags

total_sourcesinteger

Total number of sources

total_usersinteger

Total number of users

uidstring

Org UID

user_workidinteger

User selected workid

valid_fromstring date-time

Valid from date, the first date this object was valid

valid_tostring date-time

Valid to date, the date this object is valid to

Changes

No recorded changes to this operation across all 1 revision of this API.