<commit_before># Configuration Commands
**(DEPRECATED use cf-mgmt-config instead)**
* [add-org-to-config](add-org-to-config/README.md)
* [add-space-to-config](add-space-to-config/README.md)
* [generate-concourse-pipeline](generate-concourse-pipeline/README.md)
* [init-config](init-config/README.md)


# Commands

The following commands are enabled with cf-mgmt that will leverage configuration interact with your Cloud Foundry installation and need to authenticate

## Authentication requirements

Introduced in cf-mgmt 0.0.66+ is the ability to definee a non admin uaa client.  With this release the password field has been deprecated. To create a non-admin client execute the following command with [Cloud Foundry UAA Client](https://docs.pivotal.io/pivotalcf/1-11/adminguide/uaa-user-management.html).  

```
$ uaac target uaa.<system-domain>
$ uaac token client get <adminuserid> -s <admin-client-secret>

$ uaac client add cf-mgmt \
  --name cf-mgmt \
  --secret <cf-mgmt-secret> \
  --authorized_grant_types client_credentials,refresh_token \
  --authorities cloud_controller.admin,scim.read,scim.write
```

As you can see, `cloud_controller.admin,scim.read,scim.write` gives this user just enough rights to add/update/delete users, orgs and space and still being a non-admin user. Learn more about the scopes authorized by UAA at [UAA Scopes](https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-APIs.rst#scopes-authorized-by-the-uaa)


To execute any of the following you will need to provide:
- **user-id** that has privileges to create/update/delete users, orgs and spaces. This user doesn't have to be an admin user. Assuming you have [Cloud Foundry UAA
- **client-secret** for the above user (assumes the same user account for cf commands is used)
- **system-domain** name of your foundation

Prior to v0.0.66 a **password** was also needed as you had to provide both a uaa user and uaa client.  This field has been deprecated and will be removed in a future release as going forward cf-mgmt will require a uaa client per the authentication directions.

* [create-org-private-domains](create-org-private-domains/README.md)
* [create-orgs](create-orgs/README.md)
* [create-security-groups](create-security-groups/README.md)
* [create-spaces](create-spaces/README.md)
* [delete-orgs](delete-orgs/README.md)<commit_msg>Update to link to share private domains doc<commit_after># Configuration Commands
**(DEPRECATED use cf-mgmt-config instead)**
* [add-org-to-config](add-org-to-config/README.md)
* [add-space-to-config](add-space-to-config/README.md)
* [generate-concourse-pipeline](generate-concourse-pipeline/README.md)
* [init-config](init-config/README.md)


# Commands

The following commands are enabled with cf-mgmt that will leverage configuration interact with your Cloud Foundry installation and need to authenticate

## Authentication requirements

Introduced in cf-mgmt 0.0.66+ is the ability to definee a non admin uaa client.  With this release the password field has been deprecated. To create a non-admin client execute the following command with [Cloud Foundry UAA Client](https://docs.pivotal.io/pivotalcf/1-11/adminguide/uaa-user-management.html).  

```
$ uaac target uaa.<system-domain>
$ uaac token client get <adminuserid> -s <admin-client-secret>

$ uaac client add cf-mgmt \
  --name cf-mgmt \
  --secret <cf-mgmt-secret> \
  --authorized_grant_types client_credentials,refresh_token \
  --authorities cloud_controller.admin,scim.read,scim.write
```

As you can see, `cloud_controller.admin,scim.read,scim.write` gives this user just enough rights to add/update/delete users, orgs and space and still being a non-admin user. Learn more about the scopes authorized by UAA at [UAA Scopes](https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-APIs.rst#scopes-authorized-by-the-uaa)


To execute any of the following you will need to provide:
- **user-id** that has privileges to create/update/delete users, orgs and spaces. This user doesn't have to be an admin user. Assuming you have [Cloud Foundry UAA
- **client-secret** for the above user (assumes the same user account for cf commands is used)
- **system-domain** name of your foundation

Prior to v0.0.66 a **password** was also needed as you had to provide both a uaa user and uaa client.  This field has been deprecated and will be removed in a future release as going forward cf-mgmt will require a uaa client per the authentication directions.

* [create-org-private-domains](create-org-private-domains/README.md)
* [share-org-private-domains](share-org-private-domains/README.md)
* [create-orgs](create-orgs/README.md)
* [create-security-groups](create-security-groups/README.md)
* [create-spaces](create-spaces/README.md)
* [delete-orgs](delete-orgs/README.md)
{'fraction_non_alphanumeric': 0.10896493806424522, 'fraction_numerical': 0.004618937644341801, 'mean_word_length': 4.604705882352941, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1146639', 'n_tokens_mistral': 1514, 'n_tokens_neox': 1470, 'n_words': 477}