/v2/orgs/{org_name}/members/export Export members of an organization as a CSV
This operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.
Connection and access
API connection and authentication guidance
https://hub.docker.com
—
Docker HUB API
Use one of these alternatives. Requirements within an alternative apply together.
bearerAuth
Parameters
org_name
path
Required
Type:
string
All schema constraints and annotations
{
"type": "string"
}Request and responses
Response
200
text/csv
Headers
Content-Disposition{
"example": "attachment;filename=\"{org_name}-members-{timestamp}.csv\"",
"schema": {
"type": "string"
}
}Type:
string
All schema constraints and annotations
{
"description": "CSV columns: Name, Username, Email, Type, Role, Teams, and Date Joined. The Role column contains the assigned role label. When administrative insights are available, the export also includes Last Logged-in Date, Docker Desktop Version, Last Seen Date, and Opted Out Analytics.",
"type": "string"
}Example
Name,Username,Email,Type,Role,Teams,Date Joined
Jon Snow,dockeruser,example@docker.com,User,Owner,owners,2021-01-05 21:06:53.5064 +0000 UTC
Response
400
application/json
Schema:
error
error
{
"errinfo": null,
"message": "bad request"
}Response
401
application/json
Schema:
error
error
{
"errinfo": null,
"message": "unauthorized"
}Response
403
application/json
Schema:
error
error
{
"errinfo": null,
"message": "permission denied"
}Response
404
application/json
Schema:
error
error
{
"errinfo": null,
"message": "not found"
}Referenced schemas
Complete operation contract
{
"description": "Export members of an organization as a CSV\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n",
"operationId": "getV2OrgsByOrgNameMembersExport",
"responses": {
"200": {
"content": {
"text/csv": {
"example": "Name,Username,Email,Type,Role,Teams,Date Joined\nJon Snow,dockeruser,example@docker.com,User,Owner,owners,2021-01-05 21:06:53.5064 +0000 UTC\n",
"schema": {
"description": "CSV columns: Name, Username, Email, Type, Role, Teams, and Date Joined. The Role column contains the assigned role label. When administrative insights are available, the export also includes Last Logged-in Date, Docker Desktop Version, Last Seen Date, and Opted Out Analytics.",
"type": "string"
}
}
},
"description": "Exported members",
"headers": {
"Content-Disposition": {
"example": "attachment;filename=\"{org_name}-members-{timestamp}.csv\"",
"schema": {
"type": "string"
}
}
}
},
"400": {
"$ref": "#/components/responses/bad_request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Export org members CSV",
"tags": [
"orgs"
]
}