Identity Broker Documentation Index
Command-Line Tool Reference Home

broker-admin

↓Description
↓Examples
↓Subcommands
↓Arguments

Description

Invoke administrative operations over the Identity Broker REST API.

This tool features commands that allow you to invoke administrative operations over the Identity Broker REST API. See the --help-subcommands option for a list of supported sub-commands.

Examples

List information about all available application properties: 
broker-admin list-properties --type application

Subcommands

↓create-action
↓create-application
↓create-application-group
↓create-claims-map
↓create-dataview-schema
↓create-policy-sandbox
↓create-purpose
↓create-request
↓create-resource
↓create-resource-alias
↓create-scope
↓create-tag
↓create-trace-filter
↓create-trust-level
↓delete-action
↓delete-application
↓delete-application-group
↓delete-claims-map
↓delete-dataview-mapping
↓delete-dataview-schema
↓delete-policy
↓delete-policy-sandbox
↓delete-policy-set
↓delete-policy-template
↓delete-purpose
↓delete-request
↓delete-resource
↓delete-resource-alias
↓delete-scope
↓delete-tag
↓delete-trace-filter
↓delete-trust-level
↓export
↓export-policy
↓export-policy-set
↓export-policy-template
↓get-action-prop
↓get-application-group-prop
↓get-application-prop
↓get-claims-map-prop
↓get-dataview-schema-prop
↓get-policy-sandbox-prop
↓get-policy-template-parameters
↓get-purpose-prop
↓get-request-prop
↓get-resource-alias-prop
↓get-resource-prop
↓get-scope-prop
↓get-tag-prop
↓get-trace-filter-prop
↓get-trust-level-prop
↓import
↓import-policy
↓import-policy-set
↓import-policy-template
↓instantiate-policy-template
↓list-actions
↓list-application-groups
↓list-applications
↓list-claims-maps
↓list-dataview-mappings
↓list-dataview-schemas
↓list-dataviews
↓list-policies
↓list-policy-sandboxes
↓list-policy-sets
↓list-policy-templates
↓list-properties
↓list-purposes
↓list-requests
↓list-resource-aliases
↓list-resources
↓list-scopes
↓list-tags
↓list-trace-filters
↓list-trust-levels
↓reset-application-client-secret
↓set-action-prop
↓set-application-group-prop
↓set-application-prop
↓set-claims-map-prop
↓set-dataview-mapping
↓set-dataview-schema-prop
↓set-policy-sandbox-prop
↓set-purpose-prop
↓set-request-prop
↓set-resource-alias-prop
↓set-resource-prop
↓set-scope-prop
↓set-tag-prop
↓set-trace-filter-prop
↓set-trust-level-prop
↓show-policy
↓show-policy-set
↓update-policy
↓update-policy-set
↓update-policy-template

create-action

Create action

Required properties are: name. Use 'broker-admin list-properties --type action' to see all available properties


create-action Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-application

Create application

Required properties are: name. Use 'broker-admin list-properties --type application' to see all available properties


create-application Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-application-group

Create application-group

Required properties are: name, applicationGroupMemberIds. Use 'broker-admin list-properties --type application-group' to see all available properties


create-application-group Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-claims-map

Create claims-map

Required properties are: name, schemaId. Use 'broker-admin list-properties --type claims-map' to see all available properties


create-claims-map Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-dataview-schema

Create dataview-schema

Required properties are: name, schemaJson. Use 'broker-admin list-properties --type dataview-schema' to see all available properties


create-dataview-schema Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-policy-sandbox

Create policy-sandbox

Required properties are: name, includeEnabledPolicies. Use 'broker-admin list-properties --type policy-sandbox' to see all available properties


create-policy-sandbox Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-purpose

Create purpose

Required properties are: name. Use 'broker-admin list-properties --type purpose' to see all available properties


create-purpose Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-request

Create request

Required properties are: name, requestXml. Use 'broker-admin list-properties --type request' to see all available properties


create-request Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-resource

Create resource

Required properties are: name, urn. Use 'broker-admin list-properties --type resource' to see all available properties


create-resource Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-resource-alias

Create resource-alias

Required properties are: name, resourceId. Use 'broker-admin list-properties --type resource-alias' to see all available properties


create-resource-alias Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-scope

Create scope

Required properties are: name, immutableTokenName, actionId, resourceIds. Use 'broker-admin list-properties --type scope' to see all available properties


create-scope Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-tag

Create tag

Required properties are: name. Use 'broker-admin list-properties --type tag' to see all available properties


create-tag Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-trace-filter

Create trace-filter

Required properties are: name, enabled, targetXml. Use 'broker-admin list-properties --type trace-filter' to see all available properties


create-trace-filter Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

create-trust-level

Create trust-level

Required properties are: name, value. Use 'broker-admin list-properties --type trust-level' to see all available properties


create-trust-level Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

delete-action

Delete action


delete-action Arguments

--id {id}

Description The ID of the action
Required No
Multi-Valued No

--name {name}

Description The name of the action. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-application

Delete application


delete-application Arguments

--id {id}

Description The ID of the application
Required No
Multi-Valued No

--name {name}

Description The name of the application. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-application-group

Delete application-group


delete-application-group Arguments

--id {id}

Description The ID of the application-group
Required No
Multi-Valued No

--name {name}

Description The name of the application-group. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-claims-map

Delete claims-map


delete-claims-map Arguments

--id {id}

Description The ID of the claims-map
Required No
Multi-Valued No

--name {name}

Description The name of the claims-map. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-dataview-mapping

Delete a mapping for a specified data view attribute to a specified store adapter, or to any store adapter


delete-dataview-mapping Arguments

--dataview {dataview}

Description The name of the data view
Required Yes
Multi-Valued No

--commonURN {URN}

Description The URN of the data view attribute
Required Yes
Multi-Valued No

--adapter {store-adapter}

Description The name of the store adapter
Required No
Multi-Valued No

delete-dataview-schema

Delete dataview-schema


delete-dataview-schema Arguments

--id {id}

Description The ID of the dataview-schema
Required No
Multi-Valued No

--name {name}

Description The name of the dataview-schema. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-policy

Delete policy


delete-policy Arguments

--id {URI}

Description The ID of the policy
Required No
Multi-Valued No

--name {name}

Description The name of the policy. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--force

Description Specifies that the policy should be deleted even if there are existing references to it. By default, the delete operation fails if there are existing references

delete-policy-sandbox

Delete policy-sandbox


delete-policy-sandbox Arguments

--id {id}

Description The ID of the policy-sandbox
Required No
Multi-Valued No

--name {name}

Description The name of the policy-sandbox. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-policy-set

Delete policy-set


delete-policy-set Arguments

--id {URI}

Description The ID of the policy-set
Required No
Multi-Valued No

--name {name}

Description The name of the policy-set. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--force

Description Specifies that the policy-set should be deleted even if there are existing references to it. By default, the delete operation fails if there are existing references

delete-policy-template

Delete policy-template


delete-policy-template Arguments

--id {URI}

Description The ID of the policy-template
Required No
Multi-Valued No

--name {name}

Description The name of the policy-template. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-purpose

Delete purpose


delete-purpose Arguments

--id {id}

Description The ID of the purpose
Required No
Multi-Valued No

--name {name}

Description The name of the purpose. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-request

Delete request


delete-request Arguments

--id {id}

Description The ID of the request
Required No
Multi-Valued No

--name {name}

Description The name of the request. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-resource

Delete resource


delete-resource Arguments

--id {id}

Description The ID of the resource
Required No
Multi-Valued No

--name {name}

Description The name of the resource. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-resource-alias

Delete resource-alias


delete-resource-alias Arguments

--id {id}

Description The ID of the resource-alias
Required No
Multi-Valued No

--name {name}

Description The name of the resource-alias. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-scope

Delete scope


delete-scope Arguments

--id {id}

Description The ID of the scope
Required No
Multi-Valued No

--name {name}

Description The name of the scope. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-tag

Delete tag


delete-tag Arguments

--id {id}

Description The ID of the tag
Required No
Multi-Valued No

--name {name}

Description The name of the tag. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-trace-filter

Delete trace-filter


delete-trace-filter Arguments

--id {id}

Description The ID of the trace-filter
Required No
Multi-Valued No

--name {name}

Description The name of the trace-filter. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

delete-trust-level

Delete trust-level


delete-trust-level Arguments

--id {id}

Description The ID of the trust-level
Required No
Multi-Valued No

--name {name}

Description The name of the trust-level. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

export

Export the contents of the Broker Store


export Arguments

-f {path}
--exportFile {path}

Description The file to be written with the contents of the Broker Store
Required Yes
Multi-Valued No

export-policy

Export policy


export-policy Arguments

--id {URI}

Description The ID of the policy
Required No
Multi-Valued No

--name {name}

Description The name of the policy. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--xmlFile {path}

Description Path to the XACML file to be written. If not specified, the XACML will be written as output of the command
Required No
Multi-Valued No

export-policy-set

Export policy-set


export-policy-set Arguments

--id {URI}

Description The ID of the policy-set
Required No
Multi-Valued No

--name {name}

Description The name of the policy-set. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--xmlFile {path}

Description Path to the XACML file to be written. If not specified, the XACML will be written as output of the command
Required No
Multi-Valued No

export-policy-template

Export policy-template


export-policy-template Arguments

--id {URI}

Description The ID of the policy-template
Required No
Multi-Valued No

--name {name}

Description The name of the policy-template. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--xmlFile {path}

Description Path to the XACML file to be written. If not specified, the XACML will be written as output of the command
Required No
Multi-Valued No

get-action-prop

Show action properties


get-action-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-action-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-action-prop --id 8AP --property name --outputFile name.txt

get-action-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the action
Required No
Multi-Valued No

--name {name}

Description The name of the action. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-application-group-prop

Show application-group properties


get-application-group-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-application-group-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-application-group-prop --id 8AP --property name \
     --outputFile name.txt

get-application-group-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the application-group
Required No
Multi-Valued No

--name {name}

Description The name of the application-group. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-application-prop

Show application properties


get-application-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-application-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-application-prop --id 8AP --property name \
     --outputFile name.txt

get-application-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the application
Required No
Multi-Valued No

--name {name}

Description The name of the application. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-claims-map-prop

Show claims-map properties


get-claims-map-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-claims-map-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-claims-map-prop --id 8AP --property name --outputFile name.txt

get-claims-map-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the claims-map
Required No
Multi-Valued No

--name {name}

Description The name of the claims-map. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-dataview-schema-prop

Show dataview-schema properties


get-dataview-schema-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-dataview-schema-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-dataview-schema-prop --id 8AP --property name \
     --outputFile name.txt

get-dataview-schema-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the dataview-schema
Required No
Multi-Valued No

--name {name}

Description The name of the dataview-schema. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-policy-sandbox-prop

Show policy-sandbox properties


get-policy-sandbox-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-policy-sandbox-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-policy-sandbox-prop --id 8AP --property name \
     --outputFile name.txt

get-policy-sandbox-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the policy-sandbox
Required No
Multi-Valued No

--name {name}

Description The name of the policy-sandbox. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-policy-template-parameters

Retrieve policy-template parameters


get-policy-template-parameters Arguments

--id {URI}

Description The ID of the policy-template
Required No
Multi-Valued No

--name {name}

Description The name of the policy template. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

get-purpose-prop

Show purpose properties


get-purpose-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-purpose-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-purpose-prop --id 8AP --property name --outputFile name.txt

get-purpose-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the purpose
Required No
Multi-Valued No

--name {name}

Description The name of the purpose. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-request-prop

Show request properties


get-request-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-request-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-request-prop --id 8AP --property name --outputFile name.txt

get-request-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the request
Required No
Multi-Valued No

--name {name}

Description The name of the request. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-resource-alias-prop

Show resource-alias properties


get-resource-alias-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-resource-alias-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-resource-alias-prop --id 8AP --property name \
     --outputFile name.txt

get-resource-alias-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the resource-alias
Required No
Multi-Valued No

--name {name}

Description The name of the resource-alias. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-resource-prop

Show resource properties


get-resource-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-resource-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-resource-prop --id 8AP --property name --outputFile name.txt

get-resource-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the resource
Required No
Multi-Valued No

--name {name}

Description The name of the resource. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-scope-prop

Show scope properties


get-scope-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-scope-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-scope-prop --id 8AP --property name --outputFile name.txt

get-scope-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the scope
Required No
Multi-Valued No

--name {name}

Description The name of the scope. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-tag-prop

Show tag properties


get-tag-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-tag-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-tag-prop --id 8AP --property name --outputFile name.txt

get-tag-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the tag
Required No
Multi-Valued No

--name {name}

Description The name of the tag. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-trace-filter-prop

Show trace-filter properties


get-trace-filter-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-trace-filter-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-trace-filter-prop --id 8AP --property name \
     --outputFile name.txt

get-trace-filter-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the trace-filter
Required No
Multi-Valued No

--name {name}

Description The name of the trace-filter. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

get-trust-level-prop

Show trust-level properties


get-trust-level-prop Examples

Retrieves all properties of an instance with the given name and displays them in a table: 
broker-admin get-trust-level-prop --name Example


Retrieves the property value of an instance with the given ID and writes it to the specified file: 
broker-admin get-trust-level-prop --id 8AP --property name \
     --outputFile name.txt

get-trust-level-prop Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the trust-level
Required No
Multi-Valued No

--name {name}

Description The name of the trust-level. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--outputFile {path}

Description Path to the file where the property value is to be written. If this option is specified then a single property must be specified using the --property option and this property must be single-valued
Required No
Multi-Valued No

import

Import the contents of the Broker Store


import Arguments

-f {path}
--importFile {path}

Description The file to be imported, generated by a previous export
Required Yes
Multi-Valued No

import-policy

Import policy


import-policy Arguments

-f {path}
--xmlFile {path}

Description Path to the XACML file for the policy
Required Yes
Multi-Valued No

--name {name}

Description The name to be assigned to the policy. If not specified, the name defaults to the ID from the XACML file
Required No
Multi-Valued No

--enable

Description Specifies that the policy should be enabled

--overWrite

Description If the policy already exists, then overwrite it instead of failing

import-policy-set

Import policy-set


import-policy-set Arguments

-f {path}
--xmlFile {path}

Description Path to the XACML file for the policy-set
Required Yes
Multi-Valued No

--name {name}

Description The name to be assigned to the policy-set. If not specified, the name defaults to the ID from the XACML file
Required No
Multi-Valued No

--enable

Description Specifies that the policy-set should be enabled

--overWrite

Description If the policy-set already exists, then overwrite it instead of failing

import-policy-template

Import policy-template


import-policy-template Arguments

-f {path}
--xmlFile {path}

Description Path to the XACML file for the policy-template
Required Yes
Multi-Valued No

--name {name}

Description The name to be assigned to the policy-template. If not specified, the name defaults to the ID from the XACML file
Required No
Multi-Valued No

--overWrite

Description If the policy-template already exists, then overwrite it instead of failing

instantiate-policy-template

Create a new policy from a policy template, or replace an existing policy derived from a template


instantiate-policy-template Examples

Create a new policy instantiated from a template named 'Example Template'. The policy will not be enabled: 
broker-admin instantiate-policy-template --name "Example Template" \
     --parameter "param1:Example Parameter Value" \
     --policyName "Example Instantiated Policy" \
     --description "Policy instantiated from Example Template"


Replace an existing policy named 'Example Instantiated Policy', instantiated from a template named 'Example Template', with new parameter values. The policy will be enabled: 
broker-admin instantiate-policy-template --name "Example Template" \
     --parameter "param1:New Example Parameter Value" \
     --existingPolicyName "Example Instantiated Policy" --enabled

instantiate-policy-template Arguments

--id {URI}

Description The ID of the policy-template
Required No
Multi-Valued No

--name {name}

Description The name of the policy template. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--parameter {PARAM:VALUE}

Description Assign a value to a template parameter, where PARAM is the name of the parameter and VALUE is the value to be assigned
Required Yes
Multi-Valued Yes

--existingPolicyId {policy-id}

Description The ID of an existing instantiated policy that is to be replaced
Required No
Multi-Valued No

--existingPolicyName {name}

Description The name of an existing instantiated policy that is to be replaced
Required No
Multi-Valued No

--policyName {name}

Description The name to be assigned to the policy. If not specified, the name defaults to the ID from the XACML file
Required No
Multi-Valued No

--description {description}

Description The description of the policy to be created
Required No
Multi-Valued No

--enable

Description Specifies that the policy should be enabled

list-actions

List the set of actions known to the Identity Broker


list-actions Examples

List all items in ascending order of their name: 
broker-admin list-actions --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-actions --startIndex 10 --count 5

list-actions Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-application-groups

List the set of application-groups known to the Identity Broker


list-application-groups Examples

List all items in ascending order of their name: 
broker-admin list-application-groups --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-application-groups --startIndex 10 --count 5

list-application-groups Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-applications

List the set of applications known to the Identity Broker


list-applications Examples

List all items in ascending order of their name: 
broker-admin list-applications --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-applications --startIndex 10 --count 5

list-applications Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: APPLICATION_HIDDEN,APPLICATION_UNHIDDEN,NAME_ASCENDING,NAME_DESCENDING,TRUST_LEVEL_ASCENDING,OAUTH2_ENABLED,OAUTH2_DISABLED,TRUST_LEVEL_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-claims-maps

List the set of claims-maps known to the Identity Broker


list-claims-maps Examples

List all items in ascending order of their name: 
broker-admin list-claims-maps --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-claims-maps --startIndex 10 --count 5

list-claims-maps Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING,CLAIMS_TYPE_ASCENDING,CLAIMS_TYPE_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-dataview-mappings

List attribute mappings for a specified data view


list-dataview-mappings Arguments

--dataview {dataview}

Description The name of the data view
Required Yes
Multi-Valued No

--includeSchema {all|none|not-mapped}

Description Specifies whether attribute schema should be included in the output. The default value "none" means that no schema will be included. The value "all" means that all schema will be included, and the value "not-mapped" means that only schema for attributes that are not currently mapped will be included
Allowed Values all
none
not-mapped
Default Value none
Required No
Multi-Valued No

list-dataview-schemas

List the set of dataview-schemas known to the Identity Broker


list-dataview-schemas Examples

List all items in ascending order of their name: 
broker-admin list-dataview-schemas --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-dataview-schemas --startIndex 10 --count 5

list-dataview-schemas Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-dataviews

List data views


list-dataviews Arguments

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

list-policies

List the set of policies known to the Identity Broker


list-policies Examples

List all items in ascending order of their name: 
broker-admin list-policies --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-policies --startIndex 10 --count 5

list-policies Arguments

--sourceTemplateId {URI}

Description Include only policies that were instantiated from the specified policy template
Required No
Multi-Valued No

--includePolicySet

Description For each policy in the output, show which policy sets reference that policy

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING,POLICY_ID_ASCENDING,POLICY_ID_DESCENDING,POLICY_ENABLED,POLICY_DISABLED
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

list-policy-sandboxes

List the set of policy-sandboxes known to the Identity Broker


list-policy-sandboxes Examples

List all items in ascending order of their name: 
broker-admin list-policy-sandboxes --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-policy-sandboxes --startIndex 10 --count 5

list-policy-sandboxes Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-policy-sets

List the set of policy-sets known to the Identity Broker


list-policy-sets Examples

List all items in ascending order of their name: 
broker-admin list-policy-sets --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-policy-sets --startIndex 10 --count 5

list-policy-sets Arguments

--referencedPolicyId {id}

Description Include only policy sets that have a reference to the policy with the specified ID
Required No
Multi-Valued No

--referencedPolicyName {name}

Description Include only policy sets that have a reference to the policy with the specified name
Required No
Multi-Valued No

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING,POLICY_SET_ID_ASCENDING,POLICY_SET_ID_DESCENDING,POLICY_SET_ENABLED,POLICY_SET_DISABLED
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

list-policy-templates

List the set of policy-templates known to the Identity Broker


list-policy-templates Examples

List all items in ascending order of their name: 
broker-admin list-policy-templates --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-policy-templates --startIndex 10 --count 5

list-policy-templates Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

list-properties

Lists information about available properties


list-properties Arguments

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The component type whose properties are to be listed
Required No
Multi-Valued No

list-purposes

List the set of purposes known to the Identity Broker


list-purposes Examples

List all items in ascending order of their name: 
broker-admin list-purposes --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-purposes --startIndex 10 --count 5

list-purposes Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-requests

List the set of requests known to the Identity Broker


list-requests Examples

List all items in ascending order of their name: 
broker-admin list-requests --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-requests --startIndex 10 --count 5

list-requests Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-resource-aliases

List the set of resource-aliases known to the Identity Broker


list-resource-aliases Examples

List all items in ascending order of their name: 
broker-admin list-resource-aliases --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-resource-aliases --startIndex 10 --count 5

list-resource-aliases Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-resources

List the set of resources known to the Identity Broker


list-resources Examples

List all items in ascending order of their name: 
broker-admin list-resources --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-resources --startIndex 10 --count 5

list-resources Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING,URN_ASCENDING,URN_DESCENDING,TRUST_LEVEL_ASCENDING,TRUST_LEVEL_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-scopes

List the set of scopes known to the Identity Broker


list-scopes Examples

List all items in ascending order of their name: 
broker-admin list-scopes --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-scopes --startIndex 10 --count 5

list-scopes Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING,ACTION_ASCENDING,ACTION_DESCENDING,PURPOSE_ASCENDING,PURPOSE_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-tags

List the set of tags known to the Identity Broker


list-tags Examples

List all items in ascending order of their name: 
broker-admin list-tags --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-tags --startIndex 10 --count 5

list-tags Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-trace-filters

List the set of trace-filters known to the Identity Broker


list-trace-filters Examples

List all items in ascending order of their name: 
broker-admin list-trace-filters --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-trace-filters --startIndex 10 --count 5

list-trace-filters Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-trust-levels

List the set of trust-levels known to the Identity Broker


list-trust-levels Examples

List all items in ascending order of their name: 
broker-admin list-trust-levels --sortBy NAME_ASCENDING


List up to 5 items starting with the eleventh item: 
broker-admin list-trust-levels --startIndex 10 --count 5

list-trust-levels Arguments

--sortBy {sortBy}

Description Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING,VALUE_ASCENDING,VALUE_DESCENDING
Required No
Multi-Valued No

--startIndex {startIndex}

Description The index number of the first item to be provided in the results. The default value is 0
Lower Bound 0
Required No
Multi-Valued No

--count {count}

Description The maximum number of items to be provided in the results. By default there is no maximum
Lower Bound 1
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

reset-application-client-secret

Generate a new client secret for an application


reset-application-client-secret Arguments

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

--id {id}

Description The ID of the application
Required No
Multi-Valued No

--name {name}

Description The name of the application. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

set-action-prop

Modify action properties


set-action-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-action-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-action-prop --id 8AP --set "name:New Name"

set-action-prop Arguments

--id {id}

Description The ID of the action
Required No
Multi-Valued No

--name {name}

Description The name of the action. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-application-group-prop

Modify application-group properties


set-application-group-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-application-group-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-application-group-prop --id 8AP --set "name:New Name"

set-application-group-prop Arguments

--id {id}

Description The ID of the application-group
Required No
Multi-Valued No

--name {name}

Description The name of the application-group. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-application-prop

Modify application properties


set-application-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-application-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-application-prop --id 8AP --set "name:New Name"

set-application-prop Arguments

--id {id}

Description The ID of the application
Required No
Multi-Valued No

--name {name}

Description The name of the application. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-claims-map-prop

Modify claims-map properties


set-claims-map-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-claims-map-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-claims-map-prop --id 8AP --set "name:New Name"

set-claims-map-prop Arguments

--id {id}

Description The ID of the claims-map
Required No
Multi-Valued No

--name {name}

Description The name of the claims-map. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-dataview-mapping

Create or replace a data view attribute mapping for a specified store adapter


set-dataview-mapping Arguments

--dataview {dataview}

Description The name of the data view
Required Yes
Multi-Valued No

--adapter {store-adapter}

Description The name of the store adapter
Required Yes
Multi-Valued No

--commonURN {URN}

Description The URN of the data view attribute. Any existing mapping for this attribute for the specified store adapter will be replaced
Required Yes
Multi-Valued No

--nativeURN {URN}

Description The URN of the store adapter attribute
Required Yes
Multi-Valued No

--readable

Description Specifies that the mapping is used from native attribute to data view attribute in a read operation

--writable

Description Specifies that the mapping is used from data view attribute to native attribute in a write operation

--indexed

Description Specifies that the mapping is used from data view attribute to native attribute in a search filter

--authoritative

Description Specifies that the mapping is authoritative over other store attribute mappings for the same attribute (for read operations)

set-dataview-schema-prop

Modify dataview-schema properties


set-dataview-schema-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-dataview-schema-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-dataview-schema-prop --id 8AP --set "name:New Name"

set-dataview-schema-prop Arguments

--id {id}

Description The ID of the dataview-schema
Required No
Multi-Valued No

--name {name}

Description The name of the dataview-schema. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-policy-sandbox-prop

Modify policy-sandbox properties


set-policy-sandbox-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-policy-sandbox-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-policy-sandbox-prop --id 8AP --set "name:New Name"

set-policy-sandbox-prop Arguments

--id {id}

Description The ID of the policy-sandbox
Required No
Multi-Valued No

--name {name}

Description The name of the policy-sandbox. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-purpose-prop

Modify purpose properties


set-purpose-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-purpose-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-purpose-prop --id 8AP --set "name:New Name"

set-purpose-prop Arguments

--id {id}

Description The ID of the purpose
Required No
Multi-Valued No

--name {name}

Description The name of the purpose. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-request-prop

Modify request properties


set-request-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-request-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-request-prop --id 8AP --set "name:New Name"

set-request-prop Arguments

--id {id}

Description The ID of the request
Required No
Multi-Valued No

--name {name}

Description The name of the request. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-resource-alias-prop

Modify resource-alias properties


set-resource-alias-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-resource-alias-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-resource-alias-prop --id 8AP --set "name:New Name"

set-resource-alias-prop Arguments

--id {id}

Description The ID of the resource-alias
Required No
Multi-Valued No

--name {name}

Description The name of the resource-alias. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-resource-prop

Modify resource properties


set-resource-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-resource-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-resource-prop --id 8AP --set "name:New Name"

set-resource-prop Arguments

--id {id}

Description The ID of the resource
Required No
Multi-Valued No

--name {name}

Description The name of the resource. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-scope-prop

Modify scope properties


set-scope-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-scope-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-scope-prop --id 8AP --set "name:New Name"

set-scope-prop Arguments

--id {id}

Description The ID of the scope
Required No
Multi-Valued No

--name {name}

Description The name of the scope. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-tag-prop

Modify tag properties


set-tag-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-tag-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-tag-prop --id 8AP --set "name:New Name"

set-tag-prop Arguments

--id {id}

Description The ID of the tag
Required No
Multi-Valued No

--name {name}

Description The name of the tag. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-trace-filter-prop

Modify trace-filter properties


set-trace-filter-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-trace-filter-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-trace-filter-prop --id 8AP --set "name:New Name"

set-trace-filter-prop Arguments

--id {id}

Description The ID of the trace-filter
Required No
Multi-Valued No

--name {name}

Description The name of the trace-filter. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

set-trust-level-prop

Modify trust-level properties


set-trust-level-prop Examples

Sets a new name for the instance with the specified name: 
broker-admin set-trust-level-prop --name example --set "name:New Name"


Sets a new name for the instance with the specified ID: 
broker-admin set-trust-level-prop --id 8AP --set "name:New Name"

set-trust-level-prop Arguments

--id {id}

Description The ID of the trust-level
Required No
Multi-Valued No

--name {name}

Description The name of the trust-level. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--setFromFile {PROP:PATH}

Description Assign a value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be assigned
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. For properties that reference other objects by ID, VALUE may be an ID or a name specified as name=NAME
Required No
Multi-Valued Yes

--addFromFile {PROP:PATH}

Description Add a single value to a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be added
Required No
Multi-Valued Yes

--removeFromFile {PROP:PATH}

Description Remove a single value from a property, where PROP is the name of the property and PATH is the path to a file containing the single value to be removed
Required No
Multi-Valued Yes

show-policy

Show policy details


show-policy Arguments

--id {URI}

Description The ID of the policy
Required No
Multi-Valued No

--name {name}

Description The name of the policy. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

--tab-delimited

Description Indicates that properties with multiple values should display the values all on one line separated by tabs instead of providing each value on a separate line

show-policy-set

Show the contents of a policy set


show-policy-set Arguments

--id {URI}

Description The ID of the policy-set
Required No
Multi-Valued No

--name {name}

Description The name of the policy-set. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

update-policy

Update a policy


update-policy Examples

Enable a policy with the specified name: 
broker-admin update-policy --name "Example Policy" --enable

update-policy Arguments

--id {URI}

Description The ID of the policy
Required No
Multi-Valued No

--name {name}

Description The name of the policy. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--xmlFile {path}

Description Path to the XACML file for the policy
Required No
Multi-Valued No

--newName {name}

Description The new name to be given to the policy
Required No
Multi-Valued No

--enable

Description Enable the policy

--disable

Description Disable the policy

update-policy-set

Update a policy set


update-policy-set Examples

Enable a policy set with the specified name: 
broker-admin update-policy-set --name "Example Policy Set" --enable

update-policy-set Arguments

--id {URI}

Description The ID of the policy-set
Required No
Multi-Valued No

--name {name}

Description The name of the policy-set. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--xmlFile {path}

Description Path to the XACML file for the policy-set
Required No
Multi-Valued No

--newName {name}

Description The new name to be given to the policy set
Required No
Multi-Valued No

--enable

Description Enable the policy set

--disable

Description Disable the policy set

update-policy-template

Update a policy template


update-policy-template Examples

Rename a policy template: 
broker-admin update-policy-template --name "Example Policy Template" \
     --newName "My Policy Template"

update-policy-template Arguments

--id {URI}

Description The ID of the policy-template
Required No
Multi-Valued No

--name {name}

Description The name of the policy-template. One of the --id or --name options must be specified, but not both
Required No
Multi-Valued No

-f {path}
--xmlFile {path}

Description Path to the XACML file for the policy-set
Required No
Multi-Valued No

--newName {name}

Description The new name to be given to the policy template
Required No
Multi-Valued No

Arguments

-V
--version

Description Display Identity Broker version information

-H
--help

Description Display general usage information

--help-debug

Description Display help for using debug options
Advanced Yes

-h {host}
--hostname {host}

Description Identity Broker hostname or IP address
Default Value localhost
Required No
Multi-Valued No

-p {port}
--httpPort {port}

Description Identity Broker HTTP/S port number [Default: from the local Identity Broker configuration]
Required No
Multi-Valued No

-Z
--useSSL

Description Use SSL for secure communication with the server [Default: from the local Identity Broker configuration]

-X
--trustAll

Description Trust all server SSL certificates

-P {trustStorePath}
--trustStorePath {trustStorePath}

Description Certificate trust store path
Required No
Multi-Valued No

--propertiesFilePath {propertiesFilePath}

Description Path to the file that contains default property values used for command-line arguments
Required No
Multi-Valued No

--noPropertiesFile

Description Specify that no properties file will be used to get default command-line argument values

-n
--no-prompt

Description Use non-interactive mode. If data in the command is missing, you will not be prompted and the tool will fail

--adminHostname {host}

Description The Identity Broker Admin service hostname or IP address, if it differs from that of the OAuth service [Default: from the local Identity Broker configuration]
Required No
Multi-Valued No

--adminHttpPort {port}

Description The Identity Broker Admin service HTTP(S) port number, if it differs from that of the OAuth service [Default: from the local Identity Broker configuration]
Required No
Multi-Valued No

-u {authid}
--authId {authid}

Description The administrator or user ID used to authenticate with the server
Required No
Multi-Valued No

-w {password}
--authPassword {password}

Description The administrator or user password used to authenticate with the server
Required No
Multi-Valued No

-j {path}
--authPasswordFile {path}

Description The path to a file containing the administrator or user password used to authenticate with the server
Required No
Multi-Valued No

--authClientID {client_id}

Description The client ID of the internal Identity Broker application, needed by the tool itself to obtain a bearer token to access the server [Default: from the local Identity Broker configuration]
Required No
Multi-Valued No

--authClientSecret {client_secret}

Description The client secret of the internal Identity Broker application, needed by the tool itself to obtain a bearer token to access the server [Default: from the local Identity Broker configuration]
Required No
Multi-Valued No

--script-friendly

Description Use script-friendly mode

-F {batchFilePath}
--batch-file {batchFilePath}

Description Path to a file containing a sequence of commands to run
Required No
Multi-Valued No

-c
--continueOnError

Description Continue processing even if there are errors

-Q
--quiet

Description Use quiet mode

--help-subcommands

Description Display all subcommands