{"id":19040613,"url":"https://github.com/cloudfoundry/cf-uaac","last_synced_at":"2025-05-16T01:06:40.838Z","repository":{"id":5596335,"uuid":"6803061","full_name":"cloudfoundry/cf-uaac","owner":"cloudfoundry","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-05T11:40:02.000Z","size":935,"stargazers_count":42,"open_issues_count":1,"forks_count":29,"subscribers_count":83,"default_branch":"main","last_synced_at":"2025-04-24T14:04:40.392Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"cubus/icheck-rails","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudfoundry.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-11-21T21:09:39.000Z","updated_at":"2025-03-01T10:00:34.000Z","dependencies_parsed_at":"2023-02-12T00:30:31.107Z","dependency_job_id":"639eeeb5-fd05-4ad4-8268-6de43b64ee9f","html_url":"https://github.com/cloudfoundry/cf-uaac","commit_stats":{"total_commits":314,"total_committers":48,"mean_commits":6.541666666666667,"dds":0.7515923566878981,"last_synced_commit":"acfbaabc925772405560d5abbe86f6041c418625"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcf-uaac","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcf-uaac/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcf-uaac/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fcf-uaac/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudfoundry","download_url":"https://codeload.github.com/cloudfoundry/cf-uaac/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254448579,"owners_count":22072764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T22:23:42.621Z","updated_at":"2025-05-16T01:06:35.830Z","avatar_url":"https://github.com/cloudfoundry.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CloudFoundry UAA Command Line Client\n\n![Build status](https://github.com/cloudfoundry/cf-uaac/actions/workflows/ruby.yml/badge.svg)\n[![Gem Version](https://badge.fury.io/rb/cf-uaac.png)](https://rubygems.org/gems/cf-uaac)\n\n## Operating system compatibility \n\nThe `uaac` CLI is tested on Linux and Mac OS, and is supported on these systems.\nIt is not tested or supported on Windows, though it has been known to work at some point.\n\n## Installation\n\nFrom Rubygems:\n\n`gem install cf-uaac`\n\nOr to build and install the gem:\n\n```\nbundle install\ngem build cf-uaac.gemspec\ngem install cf-uaac*.gem\n```\n\n### Troubleshooting possible installation issues\n\nYou may encounter some errors when building native extentions of the required\nGems. We redirect you to the documentation of those Gem dependencies, as many\ndifferent compilation/linking issue may occur.\n\nTypical issues with x86 Darwin systems (i.e. macOS) may involve the following\n`cflags` and `ldflags` options, for the `bundler` Gem to properly build the\nrequired Gems native extensions. You should not use them blindly without\nknowing what you're doing. If you don't want persistent workarounds in your\nBundler config, those settings can also be passed to one-off `gem install`\ninvocations. Please refer to `gem help install` and `man bundle-config`.\n\n```\nbundle config build.eventmachine --with-cflags=\"-fms-extensions\"\nbundle config build.mysql2 --with-ldflags=\"-L/usr/local/opt/openssl@1.1/lib\"\nbundle config build.thin --with-cflags=\"-fms-extensions -Wno-error=implicit-function-declaration\"\n```\n\n## Concepts\n\nThe user uses a client (like a webapp, or uaac) to do things. The client and the user have different secrets; both the user's and client's secret are passwords.\n\n\n## Connecting and logging in\n\n* `uaac help` opens up the help menu and shows a full list of commands.\n* `uaac target` tells UAAC which UAA you're targeting. e.g. `uaa.example.io`.\n* `uaac target \u003ctarget-number\u003e` lets you choose a registered target.\n* `uaac targets` lists all registered targets.\n* `uaac token client get (-s \u003cyour-client-secret\u003e)` authenticates and gets your token so it can be used by UAAC. The `-s` or `--secret` flag is for inputting your secret, otherwise it will be asked for by UAAC.\n\nNow that UAAC has your token, you're able to run commands and hit the endpoints that your client has the proper scopes for. A list of scopes can be found in [UAA's API documentation.](https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-APIs.rst#scopes-authorized-by-the-uaa)\n\nTo use the APIs, see: https://github.com/cloudfoundry/cf-uaa-lib\n\n### Caveats in connecting\n\nWhen necessary, the `--skip-ssl-validation` flag should be used once only,\nalong with the `uaac target` invocation. See `uaac target -h`.\n\n\n## Creating clients\n\nAuthenticate as `admin`, or a user with the right permissions: `clients.admin` or `clients.write`.\n\n`uaac client add -i` brings up the interactive interface. If entering multiple values, separate them with commas.\n\nScopes and authorities are different in the context of a client.\n\n* Scopes is a list of permitted scopes for this client to obtain on behalf of a user.\n* Authorities is a list of granted authorities for the client, such as `uaa.admin` or `scim.invite`.\n\n`uaac contexts` will list the scopes for a client, which correspond to the users' authorities.\n\n\n## Tests\n\nRun the tests with rake:\n\n`bundle exec rake test`\n\nRun the tests and see a fancy coverage report:\n\n`bundle exec rake cov`\n\nRun integration tests (on a server running on localhost:8080/uaa):\n\n```\nexport UAA_CLIENT_ID=\"admin\"\nexport UAA_CLIENT_SECRET=\"adminsecret\"\nexport UAA_CLIENT_TARGET=\"http://localhost:8080/uaa\"\nbundle exec rake test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry%2Fcf-uaac","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudfoundry%2Fcf-uaac","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry%2Fcf-uaac/lists"}