Skip to content

Org

Organization-level settings including support requests, notification preferences, and shared documents. Requires orgs::read permission.

Operations

Retrieve organization details and configuration settings

Request

Security
JWTAuthorizer
curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/org/mine \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
uidstring

Organization ID (UUID)

namestringrequired

Organization display name

domainstring

Root domain for this organization (e.g. "myorg.trustgrid.io")

idp_providerstring

Identity provider used for authentication (e.g. "trustgrid" for built-in)

aws_account_idstring

AWS account ID associated with the organization

supportableboolean

Whether Trustgrid support can access this org

allowed_ipsArray of strings

IP allowlist for portal access (empty = unrestricted)

emergencyDestinationstring

Emergency contact email

licensesobject

License counts for node types

technicalContactobject

Technical contact for the organization

billingContactobject

Billing contact for the organization

businessContactobject

Business contact for the organization

s3_bucketstring

S3 bucket for log exports (if configured)

s3_access_keystring

S3 access key for log exports (if configured)

s3_prefixstring

S3 key prefix for log exports (if configured)

s3_regionstring

S3 region for log exports (if configured)

Response
{
  "uid": "string",
  "name": "string",
  "domain": "string",
  "idp_provider": "string",
  "aws_account_id": "string",
  "supportable": true,
  "allowed_ips": [
    "string"
  ],
  "emergencyDestination": "string",
  "licenses": {
    "appliances": 0,
    "agents": 0
  },
  "technicalContact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "billingContact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "businessContact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "s3_bucket": "string",
  "s3_access_key": "string",
  "s3_prefix": "string",
  "s3_region": "string"
}