6.17.3. Managing organizations as a superuser with the Red Hat Quay API

Procedure

• Use the GET /api/v1/superuser/organizations endpoint to list all organizations:

  $ curl -L -X GET \
    -H "Authorization: Bearer <bearer_token>" \
    "https://<quay_server>/api/v1/superuser/organizations?name=<organization_name>"

  Example output

  {"organizations": [{"name": "fed_test", "email": "fe11fc59-bd09-459a-a21c-b57692d151c9", "avatar": {"name": "fed_test", "hash": "e2ce1fb42ec2e0602362beb64b5ebd1e6ad291b710a0355f9296c16157bef3cb", "color": "#ff7f0e", "kind": "org"}, "quotas": [{"id": 3, "limit_bytes": 10737418240, "limits": []}], "quota_report": {"quota_bytes": 0, "configured_quota": 10737418240, "running_backfill": "complete", "backfill_status": "complete"}}, {"name": "test", "email": "new-contact@test-org.com", "avatar": {"name": "test", "hash": "a15d479002b20f211568fd4419e76686d2b88a4980a5b4c4bc10420776c5f6fe", "color": "#aec7e8", "kind": "org"}, "quotas": [{"id": 2, "limit_bytes": 10737418240, "limits": [{"id": 1, "type": "Reject", "limit_percent": 90}]}], "quota_report": {"quota_bytes": 0, "configured_quota": 10737418240, "running_backfill": "complete", "backfill_status": "complete"}}]}

• Use the PUT /api/v1/superuser/organizations/{name} endpoint to change or update information for an organization:

  $ curl -X PUT \
    -H "Authorization: Bearer <bearer_token>" \
    -H "Content-Type: application/json" \
    -d '{
          "email": "<contact_email>",
          "invoice_email": <boolean_value>,
          "invoice_email_address": "<invoice_email_address>",
          "tag_expiration_s": <expiration_seconds>
        }' \
    "https://<quay_server>/api/v1/superuser/organizations/<organization_name>"

  Example output

  {"name": "test", "email": "new-contact@test-org.com", "avatar": {"name": "test", "hash": "a15d479002b20f211568fd4419e76686d2b88a4980a5b4c4bc10420776c5f6fe", "color": "#aec7e8", "kind": "org"}, "quotas": [{"id": 2, "limit_bytes": 10737418240, "limits": [{"id": 1, "type": "Reject", "limit_percent": 90}]}], "quota_report": {"quota_bytes": 0, "configured_quota": 10737418240, "running_backfill": "complete", "backfill_status": "complete"}}

• Use the DELETE /api/v1/superuser/organizations/{name} endpoint to delete and organization:

  $ curl -X DELETE \
    -H "Authorization: Bearer <bearer_token>" \
    "https://<quay_server>/api/v1/superuser/organizations/<organization_name>"

  This command does not return output in the CLI.