3Play Media: Docs

User Access

Manage user access permissions

Object Representation

Unless otherwise specified, all routes return the following data structure in the data key.

Name Type Description
user_id Integer ID of the 3Play Media user
can_upload Boolean Upload permission in the 3Play Media application
can_edit Boolean Transcript and Audio Description editing permission
can_publish Boolean Publish permission
can_manage_invoices Boolean Invoice management permission
can_manage_users Boolean User management permission
access_level String Account (super user) or Project (regular user)
account_id Integer (Super users only) Account ID this super user has access to
project_id Integer (Regular users only) Project ID this user has access to

Actions

  • Grant user access to a new resource

    POST https://api.3playmedia.com/v3/admin/user_accesses/

    Parameter Type Description Required Default
    user_id Integer ID of the 3Play Media user to grant new access Yes no default
    access_level String Resource type to grant access: "account" or "project" Yes no default
    email String Email address to verify the correct user id was provided Yes no default
    project_id Integer (Required for project access only) ID for the project to grant access to No no default
    can_upload Boolean Grant the user permission to upload files in the 3Play Media application No false
    can_edit Boolean Grant the user permission to edit Transcripts, Captions, and Audio Descriptions No false
    can_publish Boolean Grant the user permission to publish Transcripts, Captions, and Audio Description plugins No false
    can_manage_invoices Boolean Grant the user permission to manage invoices No false
    can_manage_users Boolean Grant the user permission to manage users No false
  • List existing user access permissions for a specific resource (Account or Project)

    GET https://api.3playmedia.com/v3/admin/user_accesses

    Parameter Type Description Required Default
    user_id Integer Filter accesses by user id Yes no default
    access_level String Display accesses for specific resource type: "account" or "project" Yes no default
    project_id Integer (Required for project access only) Filter accesses by project ID No no default
    can_upload Boolean Filter accesses by permission to upload files in the 3Play Media application No no default
    can_edit Boolean Filter accesses by permission to edit Transcripts, Captions, and Audio Descriptions No no default
    can_publish Boolean Filter accesses by permission to publish Transcripts, Captions, and Audio Description plugins No no default
    can_manage_invoices Boolean Filter accesses by permission to manage invoices No no default
    can_manage_users Boolean Filter accesses by permission to manage users No no default
  • Update an existing user's permissions

    PATCH https://api.3playmedia.com/v3/admin/user_accesses

    Parameter Type Description Required Default
    user_id Integer The ID of the user to update the access for Yes no default
    access_level String Resource type to update the access for: "account" or "project" Yes no default
    project_id Integer (Required for project access only) ID for the project to update access for No no default
    can_upload Boolean Grant the user permission to upload files in the 3Play Media application No no default
    can_edit Boolean Grant the user permission to edit Transcripts, Captions, and Audio Descriptions No no default
    can_publish Boolean Grant the user permission to publish Transcripts, Captions, and Audio Description plugins No no default
    can_manage_invoices Boolean Grant the user permission to manage invoices No no default
    can_manage_users Boolean Grant the user permission to manage users No no default
  • Revoke a user's access to an account or project

    POST https://api.3playmedia.com/v3/admin/user_accesses/delete

    Parameter Type Description Required Default
    user_id Integer The ID of the user to delete the access for Yes no default
    access_level String Resource type to remove access for: "account" or "project" Yes no default
    project_id Integer (Required for project access only) ID for the project to remove access to No no default