{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Org",
"title": "Org",
"type": "object",
"required": [
"active",
"guid",
"name",
"org_id",
"region",
"subscriptions",
"users"
],
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/components/schemas/DefaultFields"
}
],
"properties": {
"_id": {
"type": "string",
"description": "The id of the organization.",
"readOnly": true,
"deprecated": true,
"example": "507f1f77bcf86cd799439011"
},
"account_id": {
"type": "integer",
"description": "Account ID of the organization.",
"minimum": 10000,
"maximum": 999999,
"example": 1
},
"active": {
"type": "boolean",
"description": "Active state of the organization. Organizations become inactive after passing their end date.",
"default": true,
"example": true
},
"analytics": {
"type": "object",
"description": "Analytics details for the organization",
"additionalProperties": false,
"properties": {
"token": {
"type": "string",
"description": "Token used to identify the organization."
}
},
"example": {
"token": "eyJhbGciOiJIUzI1NiJ9.example"
}
},
"api_central": {
"type": "object",
"description": "Engage provision status",
"readOnly": true,
"example": {}
},
"branding": {
"type": "object",
"description": "Organization branding.",
"additionalProperties": false,
"properties": {
"logo": {
"type": "string",
"description": "Logo image of the company."
}
},
"example": {
"logo": "example_value"
}
},
"consumer_id": {
"type": "string",
"description": "Mapped ID of the consumer org from the configured Identity Provider.",
"example": "507f1f77bcf86cd799439011"
},
"created_by": {
"type": "object",
"description": "Details of the user that created the organization.",
"unevaluatedProperties": false,
"properties": {
"client_id": {
"type": "string",
"description": "The client_id of the client that created the organization.",
"readOnly": true
},
"email": {
"type": "string",
"format": "email",
"description": "Email address of the user that created the organization.",
"readOnly": true
},
"name": {
"type": "string",
"description": "The name of the user or client that created the organization.",
"readOnly": true
}
},
"example": {
"client_id": "507f1f77bcf86cd799439011",
"email": "[email protected]",
"name": "Example Name"
}
},
"entitlements": {
"type": "object",
"readOnly": true,
"allOf": [
{
"$ref": "#/components/schemas/Entitlements"
}
],
"example": {}
},
"guid": {
"type": "string",
"format": "uuid",
"description": "GUID identifier for the organization",
"example": "example_value"
},
"help_menu": {
"type": "object",
"description": "Contents of the help menu displayed in the navigation bar.",
"default": {
"enabled": false
},
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the custom help menu is enabled.",
"default": false
},
"defaults": {
"type": "boolean",
"description": "Whether to include the default items."
},
"icon": {
"type": "string",
"description": "Icon displayed in the navigation bar to show the help menu."
},
"items": {
"type": "array",
"description": "Custom help menu shown in the navigation bar.",
"items": {
"type": "object",
"required": [
"text",
"type",
"url"
],
"unevaluatedProperties": false,
"discriminator": {
"propertyName": "type",
"mapping": {
"url": "#/components/schemas/Org/properties/help_menu/properties/items/items/oneOf/0",
"document": "#/components/schemas/Org/properties/help_menu/properties/items/items/oneOf/1"
}
},
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"url"
]
},
"url": {
"type": "string",
"format": "url",
"description": "URL for the link."
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"document"
]
},
"url": {
"type": "string",
"description": "Document resource guid"
}
}
}
],
"properties": {
"icon": {
"type": "string",
"description": "Icon displayed in the menu for the item."
},
"new_tab": {
"type": "boolean",
"description": "Whether the link opens in a new tab."
},
"provider_guid": {
"type": "string",
"description": "The GUID of the provider a document url is for"
},
"text": {
"type": "string",
"description": "Label for the link.",
"x-no-tags": true
},
"type": {
"type": "string",
"description": "Type of the link.",
"enum": [
"document",
"url"
]
},
"url": {
"type": "string",
"description": "URL, relative path, or document resource guid for the link."
}
}
}
}
},
"example": {
"enabled": true,
"defaults": true,
"icon": "example_value",
"items": [
{
"icon": "example_value",
"new_tab": true,
"provider_guid": "example_value",
"text": "example_value",
"type": "document",
"url": "https://example.com"
}
]
}
},
"last_login": {
"type": "string",
"format": "date-time",
"description": "When the most recent session was created in the organization.",
"readOnly": true,
"example": "2026-04-21T00:00:00Z"
},
"logged_in_count": {
"type": "number",
"description": "How many session are been created in the organization.",
"readOnly": true,
"example": 1.0
},
"name": {
"type": "string",
"description": "Name of the organization.",
"minLength": 2,
"maxLength": 64,
"x-no-tags": true,
"example": "Example Name"
},
"onboarding": {
"type": "object",
"description": "Onboarding data for consumer org.",
"maxProperties": 50,
"writeOnly": true,
"patternProperties": {
"[\\w-]{21}": {
"type": [
"string",
"number",
"boolean",
"array"
],
"description": "Onboarding data field value.",
"items": {
"type": "string",
"description": "Onboarding data field multi-select option value."
}
}
},
"example": {}
},
"onboarding_required": {
"type": "array",
"readOnly": true,
"items": {
"type": "string",
"pattern": "[\\w-]{21}"
},
"example": [
"example_value"
]
},
"org_id": {
"type": "integer",
"description": "Identifier for the organization",
"example": 1
},
"origin": {
"type": [
"string",
"null"
],
"description": "Source from which the organization creation originated.",
"enum": [
"360",
"sfdc",
"signup"
],
"example": "360"
},
"pending": {
"type": "boolean",
"description": "Whether the organization is pending approval for a provider organization administator.",
"example": true
},
"provider_guid": {
"type": "string",
"format": "uuid",
"description": "GUID identifier of the owning provider if the organization is a consumer of a marketplace.",
"example": "example_value"
},
"region": {
"type": "string",
"description": "The data residency region of the organization.",
"default": "US",
"enum": [
"US",
"EU",
"AP"
],
"example": "US"
},
"security": {
"type": "object",
"description": "Security settings for the organization.",
"additionalProperties": false,
"properties": {
"access_controls": {
"type": "object",
"description": "Developer visibility controls.",
"additionalProperties": false,
"properties": {
"enviroments": {
"type": "number",
"description": "Developer access to environments. 0 - Developers cannot view environments, 1 - Developer may view all environemnts.",
"enum": [
0,
1
]
},
"service_accounts": {
"type": "number",
"description": "Developer access to service accounts. 0 - Developers cannot view service accounts, 1 - Developers may view service accounts in their teams, 2 - Developer may view all service accounts.",
"enum": [
0,
1,
2
]
},
"usage": {
"type": "number",
"description": "Developer access to usage. 0 - Developers cannot view usage, 1 - Developer may view all usage.",
"enum": [
0,
1
]
},
"users": {
"type": "number",
"description": "Developer access to users.0 - Developers cannot view users, 1 - Developers may view administrators and users in their teams, 2 - Developer may view all users.",
"enum": [
0,
1,
2
]
}
}
},
"allow_tooling": {
"type": "boolean",
"description": "Grant access using tooling credentials"
},
"disable_analytics": {
"type": "boolean",
"description": "Opt out from third-party support services."
},
"password_policy": {
"$ref": "#/components/schemas/PasswordPolicy"
},
"redact_personal": {
"type": "boolean",
"description": "Personal information like email addresses will be masked in UI.",
"default": false
}
},
"example": {
"access_controls": {
"enviroments": 0,
"service_accounts": 0,
"usage": 0,
"users": 0
},
"allow_tooling": true,
"disable_analytics": true,
"password_policy": {
"length": 1,
"max_length": 1,
"lower": 1,
"upper": 1,
"special": 1,
"digit": 1,
"lockout": 1,
"renewal": 1,
"history": 1
},
"redact_personal": true
}
},
"subscriptions": {
"type": "array",
"default": [],
"items": {
"$ref": "#/components/schemas/Subscription"
},
"example": [
{
"end_date": "2026-04-21T00:00:00Z",
"entitlements": [
{
"key": "example_value",
"value": "example_value"
}
],
"governance": "SaaS",
"id": "507f1f77bcf86cd799439011",
"opportunity_id": 1.0,
"plan": "example_value",
"product": "example_value",
"product_name": "Example Name",
"source": "API",
"start_date": "2026-04-21T00:00:00Z"
}
]
},
"support_access_code": {
"type": "integer",
"description": "Support Access Code for the org.",
"minimum": 10000,
"maximum": 999999,
"example": 1
},
"users": {
"type": "array",
"description": "List of users that are members of the organization.",
"default": [],
"items": {
"type": "object",
"required": [
"guid",
"roles"
],
"additionalProperties": false,
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"description": "GUID of the user."
},
"idp": {
"type": "string",
"description": "GUID of the Identity Provider the user is required to authenticate with to access the organization."
},
"primary": {
"type": "boolean",
"description": "Whether the user is the primary contact for the organization."
},
"roles": {
"type": "array",
"description": "Roles within the organization.",
"items": {
"type": "string",
"enum": [
"administrator",
"developer",
"auditor",
"consumer",
"usage_reporter",
"api_central_admin"
]
}
}
}
},
"example": [
{
"guid": "example_value",
"idp": "example_value",
"primary": true,
"roles": [
"administrator"
]
}
]
}
}
}