initial-rbac heading-link-icon

This section lists the Corda CLI initial-rbac arguments. You can use these commands to manually create RBAC Role-based access control. Also known as role-based security. A permission system to restrict system access based on assigned permissions. roles, as described in the Manual Bootstrapping section. For more information about these default roles, see Managing Roles and Permissions.

The user-admin command creates the UserAdminRole role.

ArgumentDescription
-k, --insecureSpecifies if insecure server connections with SSL are permitted. The default value is false.
-p, --passwordThe password for the user.
-pv, --protocol-versionThe minimum protocol version. The default value is 1.
-t, --targetThe target address of the REST API Endpoint. For example, https://host:port.
-u, --userThe username.
-y, --yieldThe duration in seconds to wait for a REST connection to become available. The default value is 10.
corda-cli.sh initial-rbac user-admin --yield 300 --user <INITIAL-USERNAME> --password <INITIAL-PASSWORD> --target <API-ENDPOINT>
corda-cli.cmd initial-rbac user-admin --yield 300 --user <INITIAL-USERNAME> --password <INITIAL-PASSWORD> --target <API-ENDPOINT>

The vnode-creator command creates the VNodeCreatorRole role.

ArgumentDescription
-k, --insecureSpecifies if insecure server connections with SSL are permitted. The default value is false.
-p, --passwordThe password for the user.
-pv, --protocol-versionThe minimum protocol version. The default value is 1.
-t, --targetThe target address of the REST API Endpoint. For example, https://host:port.
-u, --userThe username.
-y, --yieldThe duration in seconds to wait for a REST connection to become available. The default value is 10.

corda-cli.sh initial-rbac vnode-creator --yield 300 --user <INITIAL-USERNAME> --password <INITIAL-PASSWORD> --target <API-ENDPOINT>
corda-cli.cmd initial-rbac vnode-creator --yield 300 --user <INITIAL-USERNAME> --password <INITIAL-PASSWORD> --target <API-ENDPOINT>

The flow-executor command creates the FlowExecutorRole role.

ArgumentDescription
-k, --insecureSpecifies if insecure server connections with SSL are permitted. The default value is false.
-p, --passwordThe password for the user.
-pv, --protocol-versionThe minimum protocol version. The default value is 1.
-t, --targetThe target address of the REST API Endpoint. For example, https://host:port.
-u, --userThe username.
-v, --v-node-idThe short hash identifier of the virtual node that the permissions apply to.
-y, --yieldThe duration in seconds to wait for a REST connection to become available. The default value is 10.
corda-cli.sh initial-rbac flow-executor --v-node-id 253501665E9D --yield 300 --user <INITIAL-USERNAME> --password <INITIAL-PASSWORD> --target <API-ENDPOINT>
corda-cli.cmd initial-rbac flow-executor --v-node-id 253501665E9D --yield 300 --user <INITIAL-USERNAME> --password <INITIAL-PASSWORD> --target <API-ENDPOINT>

The all-cluster-roles command creates the UserAdminRole and VNodeCreatorRole roles.

ArgumentDescription
-k, --insecureSpecifies if insecure server connections with SSL are permitted. The default value is false.
-p, --passwordThe password for the user.
-pv, --protocol-versionThe minimum protocol version. The default value is 1.
-t, --targetThe target address of the REST API Endpoint. For example, https://host:port.
-u, --userThe username.
-y, --yieldThe duration in seconds to wait for a REST connection to become available. The default value is 10.
corda-cli.sh initial-rbac all-cluster-roles --yield 300 --user <INITIAL-USERNAME> --password <INITIAL-PASSWORD> --target <API-ENDPOINT>
corda-cli.cmd initial-rbac all-cluster-roles --yield 300 --user <INITIAL-USERNAME> --password <INITIAL-PASSWORD> --target <API-ENDPOINT>
Previous
initial-config
Next
mgm

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.