Collections
Collections
The Collection management API allows globus users to manage guest collections and administrators to manage mapped collections.
A mapped collection is a collection that maps the Globus Auth
identity of the user accessing the collection to a local
account in the Storage Gateway’s user space. Mapped collections
can only be created by those with an administrator
role on
the Endpoint.
A guest collection is a collection that uses the collection creator’s credentials to access the Storage Gateway data interface. ACLs may be added to a Guest Collection by using the Globus Transfer API.
Operations on Mapped Collections require an administrator
role.
Overview
Method | API Path | Description |
---|---|---|
|
Get Collection |
|
|
Update Collection |
|
|
Update Collection |
|
|
Delete Collection |
Overview
Method | API Path | Description |
---|---|---|
|
Put collection advertised owner string |
|
|
Delete role-based collection advertised owner string |
Details
Create Collection
POST /collections
Create a collection. This is used to create either a mapped or a guest collection. When created, a "collection:administrator" role for that collection will be created using the caller’s identity.
The collection is assigned a unique DNS name. For guest collections, this DNS name begins with "g-". By default, for mapped collections this name begins with "m-", but a user with an "endpoint:administrator" role may assign a custom domain name for a mapped collection.
In order to create a guest collection, the caller must have an identity that matches the Storage Gateway policies.
In order to create a mapped collection, the caller must have an "endpoint:administrator" or "endpoint:owner" role.
Authorization
-
RoleAuthorizer: [ endpoint:owner, endpoint:administrator ]
-
StorageGatewayAuthorizer [
{storage_gateway_id}
]
Request body
application/json
Collections are discoverable access points that allow data to be transferred through GridFTP or HTTPS.
A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.
Name |
Type |
Description |
body |
anyOf { |
Collections are discoverable access points that allow data to be transferred through GridFTP or HTTPS. A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest. |
Example
{
"id": "18d367d5-45cf-4724-a53e-5a685e45c942",
"manager_url": "https://gcs.data.globus.org/",
"domain_name": "i-f3c83.123.globus.org",
"high_assurance": true,
"https_url": "https://i-f3c83.123.globus.org",
"tlsftp_url": "tlsftp://i-f3c83.123.globus.org",
"collection_type": "guest",
"display_name": "Project Foo Research Data",
"connector_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
"root_path": "/",
"collection_base_path": "/",
"default_directory": "/projects",
"public": true,
"force_encryption": false,
"disable_verify": false,
"organization": "University of Example",
"department": "Data Science",
"keywords": [
"Project Foo",
"Data Intensive Science"
],
"description": "Information related to the \"Foo\" project.",
"contact_email": "project-foo@example.edu",
"contact_info": "+1 (555) 555-1234",
"info_link": "https://project-foo.example.edu/info",
"authentication_timeout_mins": 30,
"policies": {
"DATA_TYPE": "blackpearl_collection_policies#1.0.0"
},
"DATA_TYPE": "collection#1.0.0",
"user_credential_id": "1ce95432-73c7-4060-8fb2-5d61d627f164",
"mapped_collection_id": "14326300-5a33-4387-9bb0-7f85c3dc3185"
}
Responses
200 - Create Collection result
Name |
Type |
Description |
code |
string |
|
data |
array |
|
DATA_TYPE |
string |
Type of this document. |
http_response_code |
integer |
Numeric HTTP response code |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "success",
"data": [
{
"id": "18d367d5-45cf-4724-a53e-5a685e45c942",
"manager_url": "https://gcs.data.globus.org/",
"domain_name": "i-f3c83.123.globus.org",
"high_assurance": true,
"https_url": "https://i-f3c83.123.globus.org",
"tlsftp_url": "tlsftp://i-f3c83.123.globus.org",
"collection_type": "guest",
"display_name": "Project Foo Research Data",
"connector_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
"root_path": "/",
"collection_base_path": "/",
"default_directory": "/projects",
"public": true,
"force_encryption": false,
"disable_verify": false,
"organization": "University of Example",
"department": "Data Science",
"keywords": [
"Project Foo",
"Data Intensive Science"
],
"description": "Information related to the \"Foo\" project.",
"contact_email": "project-foo@example.edu",
"contact_info": "+1 (555) 555-1234",
"info_link": "https://project-foo.example.edu/info",
"authentication_timeout_mins": 30,
"policies": {
"DATA_TYPE": "blackpearl_collection_policies#1.0.0"
},
"DATA_TYPE": "collection#1.0.0",
"user_credential_id": "1ce95432-73c7-4060-8fb2-5d61d627f164",
"mapped_collection_id": "14326300-5a33-4387-9bb0-7f85c3dc3185"
}
],
"DATA_TYPE": "result#1.0.0",
"http_response_code": 200,
"detail": null,
"message": "Operation successful",
"has_next_page": false,
"marker": "string"
}
403 - Forbidden
Name |
Type |
Description |
code |
string |
|
http_response_code |
|
|
detail |
One of { object MissingRequiredRole , object NotResourceOwner , object NotFromAllowedDomain , AuthenticationTimeout , object IdNotInIdentitySet , object LimitExceeded } |
|
DATA_TYPE |
string |
Type of this document. |
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "permission_denied",
"http_response_code": 403,
"detail": {
"DATA_TYPE": "missing_required_role#1.0.0",
"roles": [
{
"role": "administrator",
"collection": "18d367d5-45cf-4724-a53e-5a685e45c942"
}
]
},
"DATA_TYPE": "result#1.0.0",
"message": "Operation successful",
"data": [
{}
],
"has_next_page": false,
"marker": "string"
}
List Collections
GET /collections
List the Collections served by this Endpoint.
This operation requires either the endpoint to have the
public
property set to true or the caller to have
a role that allows viewing this Collection.
The result of this can be limited by using the filter
query
parameter to choose which of the visible collections to return.
This is a comma-separated list of filters to apply to the
result set:
- mapped_collections
-
Only collections with collection_type equal to
mapped
. - guest_collections
-
Only collections with collection_type equal to
guest
. - managed_by_me
-
Only collections where one of caller’s identities (either directly or via a group role assignment) is granted a role on the collection.
- created_by_me
-
Only collections where one of the caller’s identities matches the
identity_id
property of the collection.
The result can also be limited by including the
mapped_collection_id
query parameter. This limits the response
to guest collections which have been created using the specified
mapped collection.
Normally, only public collection configuration policy data is
included in the response. If the query parameter
include=private_policies
is passed to this API, and the caller
has an administrator role on this collection, the response will
include all private policies for the collection as well.
Authorization
-
PublicAuthorizer
-
RoleAuthorizer: [ endpoint:owner, endpoint:administrator, endpoint:activity_manager, endpoint:activity_monitor, collection:administrator:{collection_id}, collection:activity_manager:{collection_id}, collection:activity_monitor:{collection_id}, collection:access_manager:{collection_id} ]
-
CollectionACLAuthorizer: [
{collection_id}
] -
StorageGatewayAuthorizer [
{storage_gateway_id}
]
Query Parameters
Parameter | Type | Description |
---|---|---|
marker |
string Any |
Pagination marker for a paginated response |
mapped_collection_id |
string Any |
Filter collections which were created using this mapped_collection_id. |
filter |
array(string) |
Filter to apply to the return set. |
include |
array(string) |
Document values to include. |
Responses
200 - Get Collections Response
Name |
Type |
Description |
code |
string |
|
data |
array ( Collection ) |
|
DATA_TYPE |
string |
Type of this document. |
http_response_code |
integer |
Numeric HTTP response code |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "success",
"data": [
{
"id": "18d367d5-45cf-4724-a53e-5a685e45c942",
"manager_url": "https://gcs.data.globus.org/",
"domain_name": "i-f3c83.123.globus.org",
"high_assurance": true,
"https_url": "https://i-f3c83.123.globus.org",
"tlsftp_url": "tlsftp://i-f3c83.123.globus.org",
"collection_type": "guest",
"display_name": "Project Foo Research Data",
"connector_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
"root_path": "/",
"collection_base_path": "/",
"default_directory": "/projects",
"public": true,
"force_encryption": false,
"disable_verify": false,
"organization": "University of Example",
"department": "Data Science",
"keywords": [
"Project Foo",
"Data Intensive Science"
],
"description": "Information related to the \"Foo\" project.",
"contact_email": "project-foo@example.edu",
"contact_info": "+1 (555) 555-1234",
"info_link": "https://project-foo.example.edu/info",
"authentication_timeout_mins": 30,
"policies": {
"DATA_TYPE": "blackpearl_collection_policies#1.0.0"
},
"DATA_TYPE": "collection#1.0.0",
"user_credential_id": "1ce95432-73c7-4060-8fb2-5d61d627f164",
"mapped_collection_id": "14326300-5a33-4387-9bb0-7f85c3dc3185"
}
],
"DATA_TYPE": "result#1.0.0",
"http_response_code": 200,
"detail": null,
"message": "Operation successful",
"has_next_page": false,
"marker": "string"
}
Details
Get Collection
GET /collections/{collection_id}
Get Collection returns a result containing the Collection document.
This operation requires either the endpoint to have the
public
property set to true
or the caller to have
a role that allows viewing this Endpoint. Some property
visibility is limited for users who do not have an
administrator
role.
Normally, only public collection configuration policy data is
included in the response. If the query parameter
include=private_policies
is passed to this API, and the caller
has an administrator role on this collection, the response will
include all private policies for the collection as well.
Authorization
-
PublicAuthorizer
-
RoleAuthorizer: [ endpoint:owner, endpoint:administrator, endpoint:activity_manager, endpoint:activity_monitor, collection:administrator:{collection_id}, collection:activity_manager:{collection_id}, collection:activity_monitor:{collection_id}, collection:access_manager:{collection_id} ]
-
CollectionACLAuthorizer: [
{collection_id}
] -
StorageGatewayAuthorizer [
{storage_gateway_id}
]
Query Parameters
Parameter | Type | Description |
---|---|---|
include |
array(string) |
Document values to include. |
Responses
200 - Get Collection Response
Name |
Type |
Description |
code |
string |
|
data |
array ( Collection ) |
|
DATA_TYPE |
string |
Type of this document. |
http_response_code |
integer |
Numeric HTTP response code |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "success",
"data": [
{
"id": "18d367d5-45cf-4724-a53e-5a685e45c942",
"manager_url": "https://gcs.data.globus.org/",
"domain_name": "i-f3c83.123.globus.org",
"high_assurance": true,
"https_url": "https://i-f3c83.123.globus.org",
"tlsftp_url": "tlsftp://i-f3c83.123.globus.org",
"collection_type": "guest",
"display_name": "Project Foo Research Data",
"connector_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
"root_path": "/",
"collection_base_path": "/",
"default_directory": "/projects",
"public": true,
"force_encryption": false,
"disable_verify": false,
"organization": "University of Example",
"department": "Data Science",
"keywords": [
"Project Foo",
"Data Intensive Science"
],
"description": "Information related to the \"Foo\" project.",
"contact_email": "project-foo@example.edu",
"contact_info": "+1 (555) 555-1234",
"info_link": "https://project-foo.example.edu/info",
"authentication_timeout_mins": 30,
"policies": {
"DATA_TYPE": "blackpearl_collection_policies#1.0.0"
},
"DATA_TYPE": "collection#1.0.0",
"user_credential_id": "1ce95432-73c7-4060-8fb2-5d61d627f164",
"mapped_collection_id": "14326300-5a33-4387-9bb0-7f85c3dc3185"
}
],
"DATA_TYPE": "result#1.0.0",
"http_response_code": 200,
"detail": null,
"message": "Operation successful",
"has_next_page": false,
"marker": "string"
}
Update Collection
PATCH /collections/{collection_id}
Update the Collection document, changing only the properties included in the input document. It optionally returns a document containing the document after the change is applied. Items explicitly set to null in the input are removed from the collection document.
Authorization
-
RoleAuthorizer: [ endpoint:owner, endpoint:administrator, collection:administrator:{collection_id} ]
Query Parameters
Parameter | Type | Description |
---|---|---|
include |
array(string) |
List of document types to include in the response. |
Request body
application/json
Collections are discoverable access points that allow data to be transferred through GridFTP or HTTPS.
A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.
Name |
Type |
Description |
body |
anyOf { |
Collections are discoverable access points that allow data to be transferred through GridFTP or HTTPS. A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest. |
Example
{
"id": "18d367d5-45cf-4724-a53e-5a685e45c942",
"manager_url": "https://gcs.data.globus.org/",
"domain_name": "i-f3c83.123.globus.org",
"high_assurance": true,
"https_url": "https://i-f3c83.123.globus.org",
"tlsftp_url": "tlsftp://i-f3c83.123.globus.org",
"collection_type": "guest",
"display_name": "Project Foo Research Data",
"connector_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
"root_path": "/",
"collection_base_path": "/",
"default_directory": "/projects",
"public": true,
"force_encryption": false,
"disable_verify": false,
"organization": "University of Example",
"department": "Data Science",
"keywords": [
"Project Foo",
"Data Intensive Science"
],
"description": "Information related to the \"Foo\" project.",
"contact_email": "project-foo@example.edu",
"contact_info": "+1 (555) 555-1234",
"info_link": "https://project-foo.example.edu/info",
"authentication_timeout_mins": 30,
"policies": {
"DATA_TYPE": "blackpearl_collection_policies#1.0.0"
},
"DATA_TYPE": "collection#1.0.0",
"user_credential_id": "1ce95432-73c7-4060-8fb2-5d61d627f164",
"mapped_collection_id": "14326300-5a33-4387-9bb0-7f85c3dc3185"
}
Responses
200 - Update Collection Response
Name |
Type |
Description |
code |
string |
|
data |
array ( Collection ) |
|
DATA_TYPE |
string |
Type of this document. |
http_response_code |
integer |
Numeric HTTP response code |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "success",
"data": [
{
"id": "18d367d5-45cf-4724-a53e-5a685e45c942",
"manager_url": "https://gcs.data.globus.org/",
"domain_name": "i-f3c83.123.globus.org",
"high_assurance": true,
"https_url": "https://i-f3c83.123.globus.org",
"tlsftp_url": "tlsftp://i-f3c83.123.globus.org",
"collection_type": "guest",
"display_name": "Project Foo Research Data",
"connector_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
"root_path": "/",
"collection_base_path": "/",
"default_directory": "/projects",
"public": true,
"force_encryption": false,
"disable_verify": false,
"organization": "University of Example",
"department": "Data Science",
"keywords": [
"Project Foo",
"Data Intensive Science"
],
"description": "Information related to the \"Foo\" project.",
"contact_email": "project-foo@example.edu",
"contact_info": "+1 (555) 555-1234",
"info_link": "https://project-foo.example.edu/info",
"authentication_timeout_mins": 30,
"policies": {
"DATA_TYPE": "blackpearl_collection_policies#1.0.0"
},
"DATA_TYPE": "collection#1.0.0",
"user_credential_id": "1ce95432-73c7-4060-8fb2-5d61d627f164",
"mapped_collection_id": "14326300-5a33-4387-9bb0-7f85c3dc3185"
}
],
"DATA_TYPE": "result#1.0.0",
"http_response_code": 200,
"detail": null,
"message": "Operation successful",
"has_next_page": false,
"marker": "string"
}
Update Collection
PUT /collections/{collection_id}
Update the Collection document, replacing the entire Collection with the input document. It optionally returns a document containing the document after the change is applied.
Authorization
-
RoleAuthorizer: [ endpoint:owner, endpoint:administrator, collection:administrator:{collection_id} ]
Query Parameters
Parameter | Type | Description |
---|---|---|
include |
array(string) |
List of document types to include in the response. |
Request body
application/json
Collections are discoverable access points that allow data to be transferred through GridFTP or HTTPS.
A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.
Name |
Type |
Description |
body |
anyOf { |
Collections are discoverable access points that allow data to be transferred through GridFTP or HTTPS. A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest. |
Example
{
"id": "18d367d5-45cf-4724-a53e-5a685e45c942",
"manager_url": "https://gcs.data.globus.org/",
"domain_name": "i-f3c83.123.globus.org",
"high_assurance": true,
"https_url": "https://i-f3c83.123.globus.org",
"tlsftp_url": "tlsftp://i-f3c83.123.globus.org",
"collection_type": "guest",
"display_name": "Project Foo Research Data",
"connector_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
"root_path": "/",
"collection_base_path": "/",
"default_directory": "/projects",
"public": true,
"force_encryption": false,
"disable_verify": false,
"organization": "University of Example",
"department": "Data Science",
"keywords": [
"Project Foo",
"Data Intensive Science"
],
"description": "Information related to the \"Foo\" project.",
"contact_email": "project-foo@example.edu",
"contact_info": "+1 (555) 555-1234",
"info_link": "https://project-foo.example.edu/info",
"authentication_timeout_mins": 30,
"policies": {
"DATA_TYPE": "blackpearl_collection_policies#1.0.0"
},
"DATA_TYPE": "collection#1.0.0",
"user_credential_id": "1ce95432-73c7-4060-8fb2-5d61d627f164",
"mapped_collection_id": "14326300-5a33-4387-9bb0-7f85c3dc3185"
}
Responses
200 - Update Collection Response
Name |
Type |
Description |
code |
string |
|
data |
array ( Collection ) |
|
DATA_TYPE |
string |
Type of this document. |
http_response_code |
integer |
Numeric HTTP response code |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "success",
"data": [
{
"id": "18d367d5-45cf-4724-a53e-5a685e45c942",
"manager_url": "https://gcs.data.globus.org/",
"domain_name": "i-f3c83.123.globus.org",
"high_assurance": true,
"https_url": "https://i-f3c83.123.globus.org",
"tlsftp_url": "tlsftp://i-f3c83.123.globus.org",
"collection_type": "guest",
"display_name": "Project Foo Research Data",
"connector_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
"storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
"root_path": "/",
"collection_base_path": "/",
"default_directory": "/projects",
"public": true,
"force_encryption": false,
"disable_verify": false,
"organization": "University of Example",
"department": "Data Science",
"keywords": [
"Project Foo",
"Data Intensive Science"
],
"description": "Information related to the \"Foo\" project.",
"contact_email": "project-foo@example.edu",
"contact_info": "+1 (555) 555-1234",
"info_link": "https://project-foo.example.edu/info",
"authentication_timeout_mins": 30,
"policies": {
"DATA_TYPE": "blackpearl_collection_policies#1.0.0"
},
"DATA_TYPE": "collection#1.0.0",
"user_credential_id": "1ce95432-73c7-4060-8fb2-5d61d627f164",
"mapped_collection_id": "14326300-5a33-4387-9bb0-7f85c3dc3185"
}
],
"DATA_TYPE": "result#1.0.0",
"http_response_code": 200,
"detail": null,
"message": "Operation successful",
"has_next_page": false,
"marker": "string"
}
Delete Collection
DELETE /collections/{collection_id}
Delete the Collection. This will also delete all Role documents associated with the collection’s ID.
This requires an administrator
role on the Collection.
Authorization
-
RoleAuthorizer: [ endpoint:owner, endpoint:administrator, collection:administrator:{collection_id} ]
Responses
200 - Delete Collection Response
Name |
Type |
Description |
code |
string |
|
DATA_TYPE |
string |
Type of this document. |
http_response_code |
integer |
Numeric HTTP response code |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "success",
"DATA_TYPE": "result#1.0.0",
"http_response_code": 200,
"detail": null,
"message": "Operation successful",
"data": [
{}
],
"has_next_page": false,
"marker": "string"
}
Details
Put collection advertised owner string
PUT /collections/{collection_id}/owner_string
Modify the collection’s advertised owner to match the username of one of the caller’s linked identities. The identity must have an administrator role on the collection.
Responses
200 - Set collection owner string response
Name |
Type |
Description |
code |
string |
|
DATA_TYPE |
string |
Type of this document. |
http_response_code |
integer |
Numeric HTTP response code |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "success",
"DATA_TYPE": "result#1.0.0",
"http_response_code": 200,
"detail": null,
"message": "Operation successful",
"data": [
{}
],
"has_next_page": false,
"marker": "string"
}
Delete role-based collection advertised owner string
DELETE /collections/{collection_id}/owner_string
Reset the collection’s advertised owner to the client_id of the endpoint.
Authorization
-
RoleAuthorizer: [ endpoint:administrator, endpoint:owner, collection:administrator:{collection_id} ]
Responses
200 - Reset collection owner string response
Name |
Type |
Description |
code |
string |
|
DATA_TYPE |
string |
Type of this document. |
http_response_code |
integer |
Numeric HTTP response code |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "success",
"DATA_TYPE": "result#1.0.0",
"http_response_code": 200,
"detail": null,
"message": "Operation successful",
"data": [
{}
],
"has_next_page": false,
"marker": "string"
}