Organization¶

[Internal] Get Organization Metadata¶

GET organizations/current/¶

Note

Authorized Roles: root, manager, backend

This endpoint allows you to get the metadata for the organization you’re logged to with your current token.

Response JSON Object

warnings (list-of-string) – Optional. List of warnings
org_id (string) – Organization ID
metadata (object) – Meta data, unvalidated JSON

EXAMPLE RESPONSE¶

  {
      "org_id": "WEdZJsRxKvBrn2B_m6ZA",
      "metadata": {
          "custom-int": 1,
          "custom-dict": {
              "a": 1,
              "b": 2
          }
      }
  }

[Internal] Create or Partial Update Organization¶

PATCH organizations/current/¶

Note

Authorized Roles: root, manager

For internal use only, not documented yet

Request JSON Object

metadata (object) – Meta data, unvalidated JSON
preserve (bool) – Optional. whether to use JSON_MERGE_PRESERVE instead of JSON_MERGE_PATCH

EXAMPLE QUERY BODY¶

  {
      "preserve": true,
      "metadata": {
          "custom-int": 1,
          "custom-dict": {
              "a": 1,
              "b": 2
          }
      }
  }

[Internal] Partial Update Preview Organization¶

PATCH organizations/current/preview/¶

Note

Authorized Roles: root, manager

For internal use only, not documented yet

Request JSON Object

metadata (object) – Meta data, unvalidated JSON
preserve (bool) – Optional. whether to use JSON_MERGE_PRESERVE instead of JSON_MERGE_PATCH

EXAMPLE QUERY BODY¶

  {
      "preserve": true,
      "metadata": {
          "custom-int": 1,
          "custom-dict": {
              "a": 1,
              "b": 2
          }
      }
  }

[Internal] Get SAML data configuration¶

GET organizations/saml/¶

Note

Authorized Roles: root, manager

This endpoint allows you to get the SAML details of any organization.

Response JSON Object

warnings (list-of-string) – Optional. List of warnings
id (int) – Organization ID (admin)
name (string) – Organization name
saml (object) –
Inner fields
- metadata (string) – The SAML metadata in xml
- entity_id (string) – The SAML entity_id

EXAMPLE RESPONSE¶

  {
      "id": 1,
      "name": "Organization name",
      "saml": {
        "metadata": "<?xml version=...><md:EntityDescriptor...",
        "entity_id": "https://www.crossingminds..."
      }
  }

[Internal] Create or Update SAML data configuration¶

PUT organizations/saml/¶

Note

Authorized Roles: root, manager

This endpoint allows you to update the SAML details of any organization.

Request JSON Object

saml (object) –
Optional.
Inner fields
- metadata (string) – The SAML metadata in xml
- entity_id (string) – The SAML entity_id

EXAMPLE QUERY BODY¶

  {
      "saml": {
        "metadata": "<?xml version=...><md:EntityDescriptor...",
        "entity_id": "https://www.crossingminds..."
      }
  }