Get resource usage for the organization hierarchy.

This returns the resources used by your organization and its suborganizations. This can be used to evaluate the need for a tier upgrade.

Header Parameters

• SlashID-OrgID string required

  The organization ID

  Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1

Responses

• 200
• 400

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• errors object[]

  httpcode integer

  message string
• result object

  Details of how many suborganization/persons/groups have been used by this organization hierarchy.

  pricing_tier_details object

  Details of the constraints applied to a specific pricing tier.

  name string

  Possible values: [free-trial, professional, enterprise, enterprise-with-nhi, identity-protection]

  The tier associated with a root organization.

  Your organization may be subject to various constraints depending on its tier, such as maximum number of users, rate-limits, etc.

  custom_templates_allowed boolean

  Indicates if custom email and SMS message templates are allowed

  nhi_external_connections_allowed boolean

  Indicates if external connections to non-human identity sources are allowed

  max_suborganizations int64

  Indicates the maximum number of the suborganizations in the hierarchy, not including the root organization. null indicates no limit.

  max_persons int64

  Indicates the maximum number of persons allowed, including all suborganizations in the hierarchy. null indicates no limit.

  max_groups int64

  Indicates the maximum number of groups allowed, including all suborganizations in the hierarchy. null indicates no limit.

  num_suborganizations int64

  Indicates the number of the suborganizations in the hierarchy, not including the root organization.

  num_persons int64

  Indicates the number of persons, including all suborganizations in the hierarchy.

  num_groups int64

  Indicates the groups, including all suborganizations in the hierarchy.

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ],
  "result": {
    "pricing_tier_details": {
      "name": "free-trial",
      "custom_templates_allowed": true,
      "nhi_external_connections_allowed": true,
      "max_suborganizations": 0,
      "max_persons": 0,
      "max_groups": 0
    },
    "num_suborganizations": 0,
    "num_persons": 0,
    "num_groups": 0
  }
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}