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.
broker-admin list-properties --type application
Create action
Required properties are: name
Use 'broker-admin list-properties --type action' to see all available properties
--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
Required properties are: name
Use 'broker-admin list-properties --type application' to see all available properties
--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
Required properties are: name,applicationGroupMemberIds
Use 'broker-admin list-properties --type application-group' to see all available properties
--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
Required properties are: name,dataViewId
Use 'broker-admin list-properties --type claims-map' to see all available properties
--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
Required properties are: name,endpoint,enabled
Use 'broker-admin list-properties --type dataview' to see all available properties
--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 identity-provider
Required properties are: name,subtype
Available subtypes are: oidc,google,facebook
Additional required properties for subtype 'oidc' are: clientId,clientSecret,clientAuthenticationMethod,scopes,issuer,authorizationEndpoint,tokenEndpoint,userinfoEndpoint
Additional required properties for subtype 'google' are: clientId,clientSecret,includeGrantedScopes
Additional required properties for subtype 'facebook' are: appId,clientSecret,permissions
Use 'broker-admin list-properties --type identity-provider' to see all available properties
--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
Required properties are: name,includeEnabledPolicies
Use 'broker-admin list-properties --type policy-sandbox' to see all available properties
--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
Required properties are: name
Use 'broker-admin list-properties --type purpose' to see all available properties
--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
Required properties are: name,requestXml
Use 'broker-admin list-properties --type request' to see all available properties
--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
Required properties are: name,urn
Use 'broker-admin list-properties --type resource' to see all available properties
--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
Required properties are: name,resourceId
Use 'broker-admin list-properties --type resource-alias' to see all available properties
--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
Required properties are: name,immutableTokenName,actionId,resourceIds
Use 'broker-admin list-properties --type scope' to see all available properties
--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
Required properties are: name
Use 'broker-admin list-properties --type tag' to see all available properties
--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
Required properties are: name,enabled,targetXml
Use 'broker-admin list-properties --type trace-filter' to see all available properties
--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
Required properties are: name,value
Use 'broker-admin list-properties --type trust-level' to see all available properties
--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
--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
--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
--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
--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
--id {id}
Description | The ID of the dataview |
Required | No |
Multi-Valued | No |
--name {name}
Description | The name of the dataview. One of the --id or --name options must be specified, but not both |
Required | No |
Multi-Valued | No |
Delete a mapping for a specified data view attribute to a specified store adapter, or to any store adapter
--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 identity-provider
--id {id}
Description | The ID of the identity-provider |
Required | No |
Multi-Valued | No |
--name {name}
Description | The name of the identity-provider. One of the --id or --name options must be specified, but not both |
Required | No |
Multi-Valued | No |
Delete one or more attribute mappings for an external identity provider to a data view
--dataview {dataview}
Description | The name of the data view |
Required | Yes |
Multi-Valued | No |
--provider {identity-provider}
Description | The name of the external identity provider |
Required | Yes |
Multi-Valued | No |
--commonURN {URN}
Description | The data view attribute URN of an attribute mapping to be deleted. If no values are provided then all attribute mappings for the specified data view and external identity provider are deleted |
Required | No |
Multi-Valued | Yes |
Delete policy
--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
--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
--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
--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
--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
--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
--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
--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
--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
--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
--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
--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 the contents of the Broker Store
-f {path}
--exportFile {path}
Description | The file to be written with the contents of the Broker Store |
Required | Yes |
Multi-Valued | No |
Export Data View to SCIM Schema
--id {id}
Description | The ID of the dataview |
Required | No |
Multi-Valued | No |
--name {name}
Description | The name of the dataview. One of the --id or --name options must be specified, but not both |
Required | No |
Multi-Valued | No |
-f {path}
--jsonFile {path}
Description | Path to the SCIM schema file to be written in JSON format. If not specified, the schema will be written as output of the command |
Required | No |
Multi-Valued | No |
Export policy
--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
--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
--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 |
Show action properties
broker-admin get-action-prop --name Example
broker-admin get-action-prop --id 8AP --property name --outputFile name.txt
--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 |
Show application-group properties
broker-admin get-application-group-prop --name Example
broker-admin get-application-group-prop --id 8AP --property name \ --outputFile name.txt
--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 |
Show application properties
broker-admin get-application-prop --name Example
broker-admin get-application-prop --id 8AP --property name \ --outputFile name.txt
--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 |
Show claims-map properties
broker-admin get-claims-map-prop --name Example
broker-admin get-claims-map-prop --id 8AP --property name --outputFile name.txt
--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 |
Show dataview properties
broker-admin get-dataview-prop --name Example
broker-admin get-dataview-prop --id 8AP --property name --outputFile name.txt
--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 |
Required | No |
Multi-Valued | No |
--name {name}
Description | The name of the dataview. 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 |
Show identity-provider properties
broker-admin get-identity-provider-prop --name Example
broker-admin get-identity-provider-prop --id 8AP --property name \ --outputFile name.txt
--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 identity-provider |
Required | No |
Multi-Valued | No |
--name {name}
Description | The name of the identity-provider. 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 |
Show policy-sandbox properties
broker-admin get-policy-sandbox-prop --name Example
broker-admin get-policy-sandbox-prop --id 8AP --property name \ --outputFile name.txt
--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 |
Retrieve policy-template parameters
--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 |
Show purpose properties
broker-admin get-purpose-prop --name Example
broker-admin get-purpose-prop --id 8AP --property name --outputFile name.txt
--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 |
Show request properties
broker-admin get-request-prop --name Example
broker-admin get-request-prop --id 8AP --property name --outputFile name.txt
--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 |
Show resource-alias properties
broker-admin get-resource-alias-prop --name Example
broker-admin get-resource-alias-prop --id 8AP --property name \ --outputFile name.txt
--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 |
Show resource properties
broker-admin get-resource-prop --name Example
broker-admin get-resource-prop --id 8AP --property name --outputFile name.txt
--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 |
Show scope properties
broker-admin get-scope-prop --name Example
broker-admin get-scope-prop --id 8AP --property name --outputFile name.txt
--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 |
Show tag properties
broker-admin get-tag-prop --name Example
broker-admin get-tag-prop --id 8AP --property name --outputFile name.txt
--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 |
Show trace-filter properties
broker-admin get-trace-filter-prop --name Example
broker-admin get-trace-filter-prop --id 8AP --property name \ --outputFile name.txt
--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 |
Show trust-level properties
broker-admin get-trust-level-prop --name Example
broker-admin get-trust-level-prop --id 8AP --property name \ --outputFile name.txt
--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 the contents of the Broker Store
-f {path}
--importFile {path}
Description | The file to be imported, generated by a previous export |
Required | Yes |
Multi-Valued | No |
Import Data View From SCIM Schema
-f {path}
--jsonFile {path}
Description | Path to the file containing the SCIM schema in JSON format to import |
Required | Yes |
Multi-Valued | No |
--name {dataview}
Description | The name to be assigned to the data view. If not specified, the name defaults to the schema name from the SCIM schema file |
Required | No |
Multi-Valued | No |
--endpoint {endpoint}
Description | The endpoint to be assigned to the data view. If not specified, the endpoint defaults to the schema endpoint from the SCIM schema file |
Required | No |
Multi-Valued | No |
--enable
Description | Specifies that the data view should be enabled |
--overWrite
Description | If a data view with the same name already exists, then overwrite it instead of failing |
Import policy
-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
-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
-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 |
Create a new policy from a policy template, or replace an existing policy derived from a template
broker-admin instantiate-policy-template --name "Example Template" \ --parameter "param1:Example Parameter Value" \ --policyName "Example Instantiated Policy" \ --description "Policy instantiated from Example Template"
broker-admin instantiate-policy-template --name "Example Template" \ --parameter "param1:New Example Parameter Value" \ --existingPolicyName "Example Instantiated Policy" --enabled
--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 the set of actions known to the Identity Broker
broker-admin list-actions --sortBy NAME_ASCENDING
broker-admin list-actions --startIndex 10 --count 5
--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 the set of application-groups known to the Identity Broker
broker-admin list-application-groups --sortBy NAME_ASCENDING
broker-admin list-application-groups --startIndex 10 --count 5
--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 the set of applications known to the Identity Broker
broker-admin list-applications --sortBy NAME_ASCENDING
broker-admin list-applications --startIndex 10 --count 5
--sortBy {sortBy}
Description | Specifies how the results should be sorted. Allowed values are: 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 the set of claims-maps known to the Identity Broker
broker-admin list-claims-maps --sortBy NAME_ASCENDING
broker-admin list-claims-maps --startIndex 10 --count 5
--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 attribute mappings for a specified data view
--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 the set of dataviews known to the Identity Broker
broker-admin list-dataviews --sortBy NAME_ASCENDING
broker-admin list-dataviews --startIndex 10 --count 5
--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 attribute mappings for external identity providers
--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 the set of identity-providers known to the Identity Broker
broker-admin list-identity-providers --sortBy NAME_ASCENDING
broker-admin list-identity-providers --startIndex 10 --count 5
--sortBy {sortBy}
Description | Specifies how the results should be sorted. Allowed values are: NAME_ASCENDING,NAME_DESCENDING,TYPE_ASCENDING,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 the set of policies known to the Identity Broker
broker-admin list-policies --sortBy NAME_ASCENDING
broker-admin list-policies --startIndex 10 --count 5
--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 the set of policy-sandboxes known to the Identity Broker
broker-admin list-policy-sandboxes --sortBy NAME_ASCENDING
broker-admin list-policy-sandboxes --startIndex 10 --count 5
--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 the set of policy-sets known to the Identity Broker
broker-admin list-policy-sets --sortBy NAME_ASCENDING
broker-admin list-policy-sets --startIndex 10 --count 5
--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 the set of policy-templates known to the Identity Broker
broker-admin list-policy-templates --sortBy NAME_ASCENDING
broker-admin list-policy-templates --startIndex 10 --count 5
--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 |
Lists information about available properties
--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 the set of purposes known to the Identity Broker
broker-admin list-purposes --sortBy NAME_ASCENDING
broker-admin list-purposes --startIndex 10 --count 5
--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 the set of requests known to the Identity Broker
broker-admin list-requests --sortBy NAME_ASCENDING
broker-admin list-requests --startIndex 10 --count 5
--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 the set of resource-aliases known to the Identity Broker
broker-admin list-resource-aliases --sortBy NAME_ASCENDING
broker-admin list-resource-aliases --startIndex 10 --count 5
--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 the set of resources known to the Identity Broker
broker-admin list-resources --sortBy NAME_ASCENDING
broker-admin list-resources --startIndex 10 --count 5
--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 the set of scopes known to the Identity Broker
broker-admin list-scopes --sortBy NAME_ASCENDING
broker-admin list-scopes --startIndex 10 --count 5
--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 store adapters
List the set of tags known to the Identity Broker
broker-admin list-tags --sortBy NAME_ASCENDING
broker-admin list-tags --startIndex 10 --count 5
--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 the set of trace-filters known to the Identity Broker
broker-admin list-trace-filters --sortBy NAME_ASCENDING
broker-admin list-trace-filters --startIndex 10 --count 5
--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 the set of trust-levels known to the Identity Broker
broker-admin list-trust-levels --sortBy NAME_ASCENDING
broker-admin list-trust-levels --startIndex 10 --count 5
--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 |
Generate a new client secret for an application
--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 |
Modify action properties
broker-admin set-action-prop --name example --set "name:New Name"
broker-admin set-action-prop --id 8AP --set "name:New Name"
--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 |
Modify application-group properties
broker-admin set-application-group-prop --name example --set "name:New Name"
broker-admin set-application-group-prop --id 8AP --set "name:New Name"
--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 |
Modify application properties
broker-admin set-application-prop --name example --set "name:New Name"
broker-admin set-application-prop --id 8AP --set "name:New Name"
--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 |
Modify claims-map properties
broker-admin set-claims-map-prop --name example --set "name:New Name"
broker-admin set-claims-map-prop --id 8AP --set "name:New Name"
--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 |
Create or replace a data view attribute mapping for a specified store adapter
--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) |
Modify dataview properties
broker-admin set-dataview-prop --name example --set "name:New Name"
broker-admin set-dataview-prop --id 8AP --set "name:New Name"
--id {id}
Description | The ID of the dataview |
Required | No |
Multi-Valued | No |
--name {name}
Description | The name of the dataview. 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 |
Create or replace an attribute mapping for an external identity provider to a data view
--dataview {dataview}
Description | The name of the data view |
Required | Yes |
Multi-Valued | No |
--provider {identity-provider}
Description | The name of the external identity provider |
Required | Yes |
Multi-Valued | No |
--commonURN {URN}
Description | The URN of the data view attribute. Any existing mapping for this attribute for the specified identity provider will be replaced |
Required | Yes |
Multi-Valued | No |
--nativeURN {URN}
Description | The URN of the external identity provider attribute |
Required | Yes |
Multi-Valued | No |
--updateOnLogin {never|only-if-missing|always}
Description | Specifies whether the mapping is applied on login to update the data view attribute. The value "never" means that the attribute will not be updated on login. The value "only-if-missing" means that the attribute will be updated if it does not currently contain any value. The value "always" means that the attribute will be updated on login |
Allowed Values |
never only-if-missing always |
Required | Yes |
Multi-Valued | No |
Modify identity-provider properties
broker-admin set-identity-provider-prop --name example --set "name:New Name"
broker-admin set-identity-provider-prop --id 8AP --set "name:New Name"
--id {id}
Description | The ID of the identity-provider |
Required | No |
Multi-Valued | No |
--name {name}
Description | The name of the identity-provider. 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 |
Modify policy-sandbox properties
broker-admin set-policy-sandbox-prop --name example --set "name:New Name"
broker-admin set-policy-sandbox-prop --id 8AP --set "name:New Name"
--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 |
Modify purpose properties
broker-admin set-purpose-prop --name example --set "name:New Name"
broker-admin set-purpose-prop --id 8AP --set "name:New Name"
--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 |
Modify request properties
broker-admin set-request-prop --name example --set "name:New Name"
broker-admin set-request-prop --id 8AP --set "name:New Name"
--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 |
Modify resource-alias properties
broker-admin set-resource-alias-prop --name example --set "name:New Name"
broker-admin set-resource-alias-prop --id 8AP --set "name:New Name"
--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 |
Modify resource properties
broker-admin set-resource-prop --name example --set "name:New Name"
broker-admin set-resource-prop --id 8AP --set "name:New Name"
--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 |
Modify scope properties
broker-admin set-scope-prop --name example --set "name:New Name"
broker-admin set-scope-prop --id 8AP --set "name:New Name"
--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 |
Modify tag properties
broker-admin set-tag-prop --name example --set "name:New Name"
broker-admin set-tag-prop --id 8AP --set "name:New Name"
--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 |
Modify trace-filter properties
broker-admin set-trace-filter-prop --name example --set "name:New Name"
broker-admin set-trace-filter-prop --id 8AP --set "name:New Name"
--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 |
Modify trust-level properties
broker-admin set-trust-level-prop --name example --set "name:New Name"
broker-admin set-trust-level-prop --id 8AP --set "name:New Name"
--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 details
--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 the contents of a policy set
--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 a policy
broker-admin update-policy --name "Example Policy" --enable
--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 a policy set
broker-admin update-policy-set --name "Example Policy Set" --enable
--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 a policy template
broker-admin update-policy-template --name "Example Policy Template" \ --newName "My Policy Template"
--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 |
-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 |