Jump to

• Request
• Response
• Examples

Update Collection Grants

put

/mobile/tools/1.0/collections/{id}/grants

Updates a storage collection's access permissions and associated roles. All current grants are deleted and replaced with those specified in this request.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The identifier of the storage collection.

Header Parameters

• If-Match(optional): string
  The request completes successfully only if the ETag of the corresponding asset matches the value of this HTTP request header. To force overwrite, pass the value `*`.

Body ()

Storage collection grants.

Root Schema : storageCollectionGrants

Type: object

Storage collection grants.

Show Source

• grants: array storageCollectionGrantArray
  Minimum Number of Items: 0

  An array of storage collection grants.

{
    "description":"Storage collection grants.",
    "type":"object",
    "properties":{
        "grants":{
            "$ref":"#/definitions/storageCollectionGrantArray"
        }
    },
    "required":[
        "grants"
    ]
}

Nested Schema : storageCollectionGrantArray

Type: array

Minimum Number of Items: 0

An array of storage collection grants.

Show Source

• [0]: object storageCollectionGrant
  Access permission and the roles that are granted that permission.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of storage collection grants.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/storageCollectionGrant"
    }
}

Nested Schema : storageCollectionGrant

Type: object

Access permission and the roles that are granted that permission.

Show Source

• action: string
  The type of access that is granted to members who have one or more of the specified roles. The valid values are READ and READ_WRITE.
• roles: array stringArray
  Minimum Number of Items: 0

  An array of string values.

{
    "description":"Access permission and the roles that are granted that permission.",
    "type":"object",
    "properties":{
        "roles":{
            "$ref":"#/definitions/stringArray"
        },
        "action":{
            "description":"The type of access that is granted to members who have one or more of the specified roles. The valid values are <code>READ</code> and <code>READ_WRITE</code>.",
            "type":"string"
        }
    },
    "required":[
        "roles",
        "action"
    ]
}

Nested Schema : stringArray

Type: array

Minimum Number of Items: 0

An array of string values.

Show Source

• [0]: string

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of string values.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

• application/json

204 Response

Grants were updated. No content was returned in this response.

400 Response

Grants were not updated due to an incorrect request.

Body ()

Root Schema : error

Type: object

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  The service's error code.
• o:errorDetails: object errorDetails
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer(int64)
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "format":"int64",
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    },
    "required":[
        "o:errorCode",
        "detail",
        "type",
        "title",
        "o:errorPath",
        "o:ecid",
        "status"
    ]
}

Nested Schema : errorDetails

Type: object

Show Source

• detail: string
• o:errorDetails: object errorDetails
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        }
    },
    "required":[
        "detail",
        "type",
        "title"
    ]
}

412 Response

The operation failed based on the `If-Match` condition. Typically, this is the result of concurrent modification detection. It also can be the result of improper values specified in the request headers.

Body ()

Root Schema : error

Type: object

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  The service's error code.
• o:errorDetails: object errorDetails
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer(int64)
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "format":"int64",
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    },
    "required":[
        "o:errorCode",
        "detail",
        "type",
        "title",
        "o:errorPath",
        "o:ecid",
        "status"
    ]
}

Nested Schema : errorDetails

Type: object

Show Source

• detail: string
• o:errorDetails: object errorDetails
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        }
    },
    "required":[
        "detail",
        "type",
        "title"
    ]
}

Examples

The following example shows how to update a collection???s grants using cURL. For more information about cURL, see Use cURL.

curl -i -X PUT  -d @body.json -H "Content-Type: application/json; charset=utf-8" -H "Authorization: Bearer $TOKEN" "$BASE_URL/mobile/tools/1.0/collections/0d1327c9-ef64-4a3f-a685-1d413cc68797/grants"

Example of Request Body

The following shows an example of the request body. This request removes all previous grants for all actions, and adds the grants specified in the body.

{
    "grants": [
        {
            "action": "READ",
            "roles": [
                "customer"
            ]
        }
    ]
}

Example of Response Header

The following shows an example of the response headers:

204 NO CONTENT
Date: Wed, 28 Jun 2017 20:00:11 GMT
Etag: "5"