Skip to content
  • There are no suggestions because the search field is empty.

Gaining a Bearer Token ⚡

Now that you have your API key, you will need to create a 'bearer token' for your application to use the API

Contents:

Top-level bearer token acquisition process

Scopes explained 

Adding the scopes to your application

Bearer token URL construction

Example bearer token URL


 

Top-level bearer token acquisition process

The application will be authenticated by the user account that created it, as the API Key is tied to a user ID. 

This means that the user account with which the application was created will always show as the record creator when importing new records. You may want to consider creating a new user account - one that clearly identifies your application. 


Scopes explained 

Scopes define the permissions allowed by your application. 

readUsersData 

The application requires this scope to view records, media, and collections. 

User Story: The application shall be able to read any data available to the user who created the application.

modifyUsersData 

The application requires this scope to view and modify records, media, and collections. 

User Story: The application shall be able to modify any data available to the user who created the application.

manageJobs 

The application requires this scope to view and manage jobs and workflows  

User Story: The application shall be able to read any jobs visible to the user who created the application.

roles 

This scope is required for the application to search for a user or group 

User Story: The application shall be able to view any users and groups visible to the user who created the application.

createJobs 

This scope is required for the application to create and manage workflow jobs

User Story: The application shall be able to create and manage any jobs that are owned by the user who created the application. 

modifyRoles 

This scope is required for the application to modify users and email users 

User Story: The application shall be able to modify any users where the user who created the application has the correct permissions


Adding the scopes to your application

The Imagen Media Control Centre must assign scopes before constructing your bearer token URL

Can't see the guide below? Open it in a new tab ↗ (may not work when viewing this page in SharePoint)
If SharePoint blocks the link, copy this address and paste it into a new browser tab:
https://scribehow.com/embed/Assigning_scopes_to_applications__1fLR3yU8SmyanFH4GAs7qg?as=scrollable&removeLogo=true

Bearer token URL construction

The next step is to construct a URL to gain your bearer token. The arguments passed by this URL are shown below in greater detail:

https://your_imagen_domain.com/oauth/authorize  Replace 'your_imagen_domain' with the FQDN of your Imagen domain
?response_type=token   (specifies that you are requesting a token in response)
&client_id=[Your API key here]  Enter the API key (obtained in the previous section)
&redirect_uri=urn:ietf:wg:oauth:2.0:oob&state=1 (specifies the default redirect value for an 'Installed Application')
&scope=readUsersData modifyUsersData  Select the scopes required by your application. It is vital that you understand the scopes before constructing a bearer token URL. 

Example bearer token URL:

https://[your_imagen_domain.com]/oauth/authorize?response_type=token &client_id=[Your_API key_here]&redirect_uri=urn:ietf:wg:oauth:2.0:oob&state=1&scope=[readUsersData modifyUsersData]

User Story: The application shall be able to read and edit any data available to the user who created the application.

👉 Want to go further? Check out a sample response 

Accessibility 👍Welcome to Imagen!Automated transcription (Speech-to-Text) 👨‍🎓Welcome to Imagen!Developers' Guide 📕 🔒Welcome to Imagen!How We Can Help You Onboard Your Content 📕Welcome to Imagen!Introduction to Imagen 📕Welcome to Imagen!Onboarding Guide 📕Welcome to Imagen!The Imagen Transcoder Farm 📕Welcome to Imagen!The Imagen Video Player 📕Welcome to Imagen!Storage Availability 🤔Welcome to Imagen!Storage Options 🤔Welcome to Imagen!Storage Security 🤔Welcome to Imagen!Which Theme Is Right for Me 🤔Welcome to Imagen!Why Is User Experience So Important? 🤔Welcome to Imagen!Imagen Term Glossary 📰Welcome to Imagen!Supported Browsers 📰Welcome to Imagen!Video Player Keyboard Shortcuts 📰Welcome to Imagen!What is a Media Object Timeline 👩‍🎓Welcome to Imagen!Newbie Checklist 👋Welcome to Imagen!Activity History ⚡FindGoogle Analytics 👩‍🎓FindAdding Annotations to Your Video Content ⚡FindAnnotation Layers 📕FindAnnotations Guide📕FindExporting Annotations ⚡FindGenerate Subtitles for Audio Content ⚡FindGenerate subtitles for video content ⚡FindGrouping Annotations on Export ⚡FindImagen Subtitle Guide 📕FindReordering Objects Within a Collection 📕FindCustom ReportingFindHow can I see the Open-Source Programming Languages used by Imagen? 🤔FindIf I search on the homepage, I get one type of search URL. But I get a different kind of URL on the "Search Results Page" 🤔FindMy search results seem out of date ⚠️FindWhat metadata does Imagen extract from my video content? 🤔FindImagen Query Language - Media Viewer Widget ⚡FindImagen Query Language Reference 📰FindUnderstanding Imagen Query Language 👨‍🏫FindArtificial Intelligence ServicesFindDescriptive Metadata Fields 📕FindExtracting Image Metadata on Import ⚡FindField Types and Record Schema 📕FindImagen Query Language - Related Records View ⚡FindImagen Query Language Guide 📕FindImagen XML Schema Mapping (XSLT) 📕FindSingle/multi-select fields - remote validationFindActivate a Language license ⚡FindChange My Default Language ⚡FindDisplay Multilanguage Annotations ⚡FindHow to configure multilanguage logos ⚡Findlanguage packs 📕FindCreating Parent/Child Field DependenciesFindDeleting RecordsFindRecords & Media Objects 📕FindUpdating Records ⚡FindAdd Fields to the Search Index ⚡FindAdding a filter to the search page ⚡FindAdvanced Search Reference 📰FindSaved Searches 📕FindSearch Index Guide 📕FindUpdating the Imagen Search Index ⚡FindBespoke Ingestion 📕StoreWhat is a 'Watchfolder'? 📕StoreImport from Dropbox ⚡StoreImport from OneDrive ⚡StoreUsing the Record (XML) Import Widget ⚡StoreCan non-media file types still be uploaded to Imagen?🤔StoreCreate a record with media ⚡StoreCreate an empty record with metadata ⚡StoreCreate Imagen XML in Excel 👩‍🎓StoreCreate multiple records, each with a single piece of media ⚡StoreImagen Media Workflows 📕StoreImport Media from a URL ⚡StoreMedia Import and Ingestion 📕StoreOptions for Onboarding your Metadata and Media 🤔StorePFR (Partial File Restore) and Segments 📕StoreWhat information do you store about my video during ingest? 🤔StoreBurnt-in Timecodes (BITC) 📕StoreThe Imagen Image Editor ⚡StoreWatermarking ⚡Store.PDF ViewerStoreAdd a Document Viewer ⚡StoreConfiguring Amazon S3 Intelligent-TieringStoreStorage Costs 📕StoreStorage Profile Reference 📄StoreStorage Replication 🌐StoreSupported File Types 📰StoreConfiguring Amazon S3 Storage TutorialStoreConfiguring Wasabi Storage TutorialStoreStorage LocationsStoreWhy Has My Media Failed to Ingest to Wasabi? 🤔StoreConfiguring "Download Profiles" ⚡DistributeInstalling and Using Imagen Accelerated File Delivery (AFD) ⚡DistributeOrdering Clips on Behalf of Other Users 📕DistributeEdit Live Stream Notification Emails ⚡DistributeImagen Live Connect API 📰DistributeAd-hoc PaymentsDistributeIntroduction to Content Licensing 📕DistributePrep: Imagen License and Stripe Accounts ⚡DistributeShopping Basket Configuration📄DistributeShopping Baskets 📕DistributeSubscription Configuration ⚡DistributeSubscription Overview 📕DistributePOST /iweb/v1/notification 📰DistributeAnonymous Sharing Links to Collections (Septeber Release)DistributeCollections 📕DistributeEmbedding Media on External SitesDistributeShare media with unregistered usersDistributeSocial Media PublishingDistributeSunrise/Sunset Dates for Open Access Links ⚡DistributeCreate an MRSS Feed ⚡DistributeImagen Live Connect 📕DistributeImagen MRSS Feed Response 📰DistributeOver the top (OTT) Delivery 📕DistributeBatch Editing Record & Media ACLManageCustom ACLsManageSet When Your Users Can Access Your Content ⚡ManageSetting Default Access Control Lists (ACL) for Records, Media, and Collections ⚡ManageSetting Record & Media Access Control Lists (ACL)ManageWhat are "ACLs"? 🤔ManageChanging Your Theme ⚡ManageDisplay banners on your site 👩‍🎓ManageI want to add a theme, which is right for me 🤔ManagePreview a theme before you commit ⚡ManageAdding Users to Groups ⚡ManageSet Permissions for a Group of Users ⚡ManageDynamic form ⚡ManageImagen Query Language - The Carousel Widget ⚡ManageMap Viewer Widget ⚡ManageWidgets 📕ManageAdobe Premiere Pro IntegrationManageCache Page 📄ManageCookies Page 📰ManageDisplay Fields 📄ManageEmail 📄ManageEnvironment Page📰ManageFederations 📰ManageGeolocation database 📰ManageGlobal Settings Page 📄ManageHealth Check Page 📰ManageMailing List 📄ManageMaintenance Mode 📄ManageThe Imagen Admin Interface Directory 📋 (Private)ManageUpdate Page 📰ManageUser Intelligence 📕ManageCreate an OrganisationManageAdding users to user groups through organisations ⚡ManageConfiguring Federated SSO ⚡ManageConfiguring your SSO service provider ⚡ManageGuide to SSO 👩‍🏫ManageI'm being sent back to ImagenWeb from the IDP but I can't get any further 🤔ManageCustom Cookie Policy (Javascript) TutorialManageImagen Event ServiceManageBanning a User from Site Access ⚡ManageClear Users That Have Not Been ValidatedManageCreate a Custom Registration ProcessManageCreating Custom Registration FieldsManageCreating request/approval relationships ⚡ManageCustomizing your Login Page ⚡ManageGrant a User Administrator PermissionsManageGrant a User Developer PermissionsManageGranting Site Permissions to an Individual User ⚡ManageGuide to Building Access Control 📕ManageIntroduction to Users, Groups, and Organisations 📕ManageManage Permissions with Imagen 📕ManagePreview Only AccessManageRestrict user sign-ups by geographyManageSetting User Signup RulesManageUser Permissions 📰ManageHow do I add reCAPTCHA to my Imagen siteManageCore REST Interface 📰DevelopersGET /api/v1/endpoints 📰DevelopersGet /core/v1/application 📰DevelopersGET /imcc/v1/job/list 📰DevelopersGET /licenceStatus/📰 WIPDevelopersGET /user/ 📰DevelopersGET history 📰DevelopersGET imcc/v1/job/count 📰DevelopersGET job/search📰DevelopersGET rights 📰DevelopersPut /imcc/v1/job 📰DevelopersAuthentication via Signed String📰DevelopersHow to authenticate API calls with a Bearer token 📰DevelopersCreating an Application in Imagen ⚡DevelopersGaining a Bearer Token ⚡DevelopersGET /iweb/v1/search 📰DevelopersImagen API Documentation 📕 🔒DevelopersGET /iweb/v1/notifications 📰DevelopersGET Profiles 📰DevelopersExample MRSS Reader (Powershell) 📄DevelopersImagen XML Reference 📰DevelopersNew metadata-only record with no media 📰DevelopersNew record with a single piece of media 📰DevelopersNew record with multiple pieces of media📰DevelopersRecord update adding new media📰DevelopersRecord update with metadata only 📰DevelopersSet ACL by XML 📰DevelopersGET /import/record 📰DevelopersGET /iweb/v1/download 📰DevelopersPUT /import/record/ 📰DevelopersCreating a Video Record with the Imagen API 👩‍🏫DevelopersFind the UMID of a media file 👩‍🏫DevelopersHow to find an Import Record (job) GUID 👩‍🏫DevelopersHow to find your Media Control Centre FQDN ⚡ 🔒DevelopersHow to find your media ID 👩‍🏫DevelopersHow to Find Your Resource Group Name 👩‍🏫DevelopersProgrammatic API Call Examples 📰DevelopersScopes 📰DevelopersStandard Failure Response 📰DevelopersWhat is a job priority? 👩‍🏫DevelopersDELETE /import/record/ 📰DevelopersDELETE /media 📰DevelopersGET /iweb/v1/users 📰DevelopersWebhooksDevelopersXML Watch Folder Tutorial (Lambda) 🔒Partners & InternalDELETE /imcc/v1/media/ 📰 🔒Partners & InternalDELETE /imcc/v1/record/ 📰 🔒Partners & InternalDELETE imcc/v1/import/record/ 📰 🔒Partners & InternalGET imcc/v1/import/record/ 📰 🔒Partners & InternalGET imcc/v1/record/search 📰 🔒Partners & InternalGET record/validateSearch 📰 🔒Partners & InternalPUT imcc/v1/import/record/ 📰 🔒Partners & InternalAdd a Video Player ⚡ 🔒Partners & InternalAdd an Audio Player ⚡ 🔒Partners & InternalAdd an Image Viewer ⚡ 🔒Partners & InternalMake a clip from a live feed in progress ⚡ 🔒Partners & InternalImagen Deployment Tutorial 🔒Partners & InternalWatchfolder Tutorial (Azure Function Media Uploaded Trigger) 🔒Partners & InternalWatchfolder Tutorial (Azure Function XML Uploaded Trigger) 🔒Partners & InternalOnboarding Playbook 🔒Partners & InternalJob and File Status Codes 📄 🔒Partners & InternalAdd a subtitles workflow to Imagen ⚡ 🔒Partners & InternalCreate a New Empty Workflow ⚡ 🔒Partners & InternalRest Plugin Setup for Vantage Integration 👩‍🔬 🔒Partners & InternalWatch Folder With FTPS Tutorial 👨‍🏫 🔒Partners & InternalXML Watch Folder Tutorial (Windows) 🔒Partners & Internal