Management API Reference for role-mapping

A mapping of users and groups to a specific role.

Children (2)

Attributes (1)

include-all - Configure if all authenticated users should be automatically assigned this role.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Configure if all authenticated users should be automatically assigned this role.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (3)

add - Add a new role mapping definition.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
include-all	BOOLEAN	false	false	false	Configure if all authenticated users should be automatically assigned this role.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new role mapping definition.",
    "request-properties" : {"include-all" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "BOOLEAN"
        },
        "description" : "Configure if all authenticated users should be automatically assigned this role.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "default" : false,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

is-caller-in-role - Test if the current caller is a member of the role.

Reply properties

Type: BOOLEAN

Raw DMR model


{
    "operation-name" : "is-caller-in-role",
    "description" : "Test if the current caller is a member of the role.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "BOOLEAN"
    }},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : false
}

remove - Remove an existing role mapping definition.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove an existing role mapping definition.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

core-service.management.access.authorization.role-mapping

        
<feature spec="core-service.management.access.authorization.role-mapping">
  <param name="role-mapping" value="{resource name}"/>
  <param name="include-all" value="{value}"/>
<feature/>