Body Required

• mappings array[object] Required

  The rules for mapping role assignments in the organization

  Hide mappings attributes Show mappings attributes object

  • enabled boolean Required

    Whether or not the role mapping is enabled

  • name string Required

    The name of the role mapping

  • rule object Required
    Hide rule attributes Show rule attributes object

    • any array[object]

      The rules that must match. Only one rule must match for the role assignment to be applied.

      Hide any attribute Show any attribute object

      • group string Required

        The group to match. Can have wildcards.

    • all array[object]

      The rules that must match. All rules must match for the role assignment to be applied.

      Hide all attribute Show all attribute object

      • group string Required

        The group to match. Can have wildcards.

  • role_assignments object Required

    Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.

    Hide role_assignments attributes Show role_assignments attributes object

    • platform array[object]

      Assignments for roles with platform scope.

      Assignment for a role with platform scope.

      Hide platform attribute Show platform attribute object

      • role_id string Required

        The ID of the role that is assigned.

    • organization array[object]

      Assignments for roles with organization scope.

      Assignment for a role with organization scope.

      Hide organization attributes Show organization attributes object

      • role_id string Required

        The ID of the role that is assigned.

      • organization_id string Required

        The ID of the organization the role is scoped to.

    • deployment array[object]

      Assignments for roles with deployment scope.

      Assignment for a role with deployment scope.

      Hide deployment attributes Show deployment attributes object

      • role_id string Required

        The ID of the role that is assigned.

      • organization_id string Required

        The ID of the organization the role is scoped to.

      • all boolean

        When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in deployment_ids.

      • deployment_ids array[string]

        The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.

      • application_roles array[string]

        If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.

    • project object

      Assignments for roles with project scope.

      Hide project attributes Show project attributes object

      • elasticsearch array[object]

        The Elasticsearch project-scoped role assignments to set

        Assignment for a role with project scope.

        Hide elasticsearch attributes Show elasticsearch attributes object

        • role_id string Required

          The ID of the role that is assigned.

        • organization_id string Required

          The ID of the organization the role is scoped to.

        • all boolean

          When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

        • project_ids array[string]

          The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

        • application_roles array[string]

          If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

      • observability array[object]

        The Observability project-scoped role assignments to set

        Assignment for a role with project scope.

        Hide observability attributes Show observability attributes object

        • role_id string Required

          The ID of the role that is assigned.

        • organization_id string Required

          The ID of the organization the role is scoped to.

        • all boolean

          When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

        • project_ids array[string]

          The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

        • application_roles array[string]

          If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

      • security array[object]

        The Security project-scoped role assignments to set

        Assignment for a role with project scope.

        Hide security attributes Show security attributes object

        • role_id string Required

          The ID of the role that is assigned.

        • organization_id string Required

          The ID of the organization the role is scoped to.

        • all boolean

          When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

        • project_ids array[string]

          The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

        • application_roles array[string]

          If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.