Get role mappings

GET /organizations/{organization_id}/role_mappings

Auth

Gets the organization role mappings. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string required: Identifier for the Organization

Responses

The IdP info

application/json

mappings object[] required: The list of role assignments for the organization

Organization not found. (code: organization.not_found)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X GET "${API_URL}/organizations/${ORGANIZATION_ID}/role_mappings" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "mappings": [
    {
      "enabled": false,
      "name": "string",
      "rule": {
        "any": [
          {
            "group": "string",
            "email": "string"
          }
        ],
        "all": [
          {
            "group": "string",
            "email": "string"
          }
        ]
      },
      "role_assignments": {
        "platform": [
          {
            "role_id": "string"
          }
        ],
        "organization": [
          {
            "role_id": "string",
            "organization_id": "string"
          }
        ],
        "deployment": [
          {
            "role_id": "string",
            "organization_id": "string",
            "all": false
          }
        ],
        "project": {
          "elasticsearch": [],
          "observability": [],
          "security": [],
          "workplaceai": [],
          "vectordb": []
        }
      }
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

Path parameters

Responses

Response headers