commands.md

Command Reference

All commands support -v / --verbose to print detailed HTTP request/response information.

Each command name below links to a page with a full description, including all available flags and usage examples.

Getting Started

Command	Description
target	Set the URL of the UAA you'd like to target
targets	List all registered targets
context	See information about the currently active CLI context
info	See version and global configurations for the targeted UAA
version	Print CLI version

Getting Tokens

Command	Description
get-client-credentials-token	Obtain an access token using the client_credentials grant type
get-password-token	Obtain an access token using the password grant type
get-authcode-token	Obtain an access token using the authorization_code grant type
get-implicit-token	Obtain an access token using the implicit grant type
refresh-token	Obtain a new access token using a refresh token
get-token-key	View the key for validating UAA's JWT token signatures
get-token-keys	View all keys the UAA has used to sign JWT tokens
decode-token	Decode a JWT and display its claims; optionally verify signature or show human-readable timestamps

Managing Clients

Command	Description
create-client	Create an OAuth client registration in the UAA
update-client	Update an OAuth client registration in the UAA
delete-client	Delete a client registration
get-client	View a client registration
list-clients	See all clients in the targeted UAA
set-client-secret	Update the secret for a client

Managing Users

Command	Description
create-user	Create a user
get-user	Look up a user by username
list-users	Search and list users with SCIM filters
delete-user	Delete a user by username
activate-user	Activate a user by username
deactivate-user	Deactivate a user by username

Managing Groups

Command	Description
create-group	Create a group
get-group	Look up a group by group name
list-groups	Search and list groups with SCIM filters
add-member	Add a user to a group
remove-member	Remove a user from a group
map-group	Map a UAA group to an external group from an identity provider
unmap-group	Remove a mapping between a UAA group and an external group
list-group-mappings	List all mappings between UAA groups and external groups

Miscellaneous

Command	Description
curl	Make an authenticated HTTP request to a UAA endpoint
userinfo	See claims about the authenticated user