PATCH /asset-permissions-api/v1/assets/permissions — openapi

Grant a subject permission to multiple assets.

Authorization is required to grant permissions to the subject and asset IDs in the request.

Endpoint

Method: PATCH

Path: /asset-permissions-api/v1/assets/permissions

Servers:

https://apis.roblox.com

Request Body

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "$ref": "#/components/schemas/BatchGrantPermissionsRequest"
      }
    },
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/BatchGrantPermissionsRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/BatchGrantPermissionsRequest"
      }
    },
    "application/*+json": {
      "schema": {
        "$ref": "#/components/schemas/BatchGrantPermissionsRequest"
      }
    }
  }
}

Responses

Status	Description
200	OK
400	Bad Request
403	Forbidden
500	Internal Server Error

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/BatchGrantPermissionsResponse"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AssetPermissions.ErrorResponse"
        }
      }
    }
  },
  "403": {
    "description": "Forbidden",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AssetPermissions.ErrorResponse"
        }
      }
    }
  },
  "500": {
    "description": "Internal Server Error",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AssetPermissions.ErrorResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Assets"
  ],
  "summary": "Grant a subject permission to multiple assets.\n            \nAuthorization is required to grant permissions to the subject and asset IDs in the request.",
  "requestBody": {
    "content": {
      "application/json-patch+json": {
        "schema": {
          "$ref": "#/components/schemas/BatchGrantPermissionsRequest"
        }
      },
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/BatchGrantPermissionsRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/BatchGrantPermissionsRequest"
        }
      },
      "application/*+json": {
        "schema": {
          "$ref": "#/components/schemas/BatchGrantPermissionsRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/BatchGrantPermissionsResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AssetPermissions.ErrorResponse"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AssetPermissions.ErrorResponse"
          }
        }
      }
    },
    "500": {
      "description": "Internal Server Error",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AssetPermissions.ErrorResponse"
          }
        }
      }
    }
  },
  "x-roblox-stability": "BETA",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 100
    }
  },
  "x-roblox-scopes": [
    {
      "name": "asset-permissions:write",
      "targetResourceSpecifier": ""
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/assets#patch_asset_permissions_api_v1_assets_permissions"
  }
}