Authentication for Azure Form Recognizer

Sachindra Narayan 21

For API authentication, I understand that Azure Form Recognizer uses "Ocp-Apim-Subscription-Key" which is the Azure Subscription ID. Also, shouldn't there be an API key as well, which we should be using for accessing any API across the subscription? Or is it there? Also, once the authentication is successful, do we have a kind of token which ensure the user remains authenticated for some time? How does this work? Moreover, as per the attached image, there are two API keys involved while using the AFR APIs. What is the use of those two keys?

1 answer

GiftA-MSFT 11,161 Reputation points

2021-06-22T20:46:30.787+00:00

Hi, thanks for reaching out. Your Azure Subscription ID is different from the Subscription Key of your resource. You can find your Subscription ID on the Overview tab. For authentication, Your API key is located on Keys and Endpoint tab (you can use Key 1 for authentication). Key 2 is more like a backup key and can useful for avoiding service interruption when when generating new keys. Hope this helps!
Please sign in to rate this answer.
Sachindra Narayan 21 Reputation points

2021-06-23T02:57:18.337+00:00

So, does that mean, for API authentication, I would only need the API key1 and nothing else, not even my Azure subscription key? If not, then how do I authenticate the API call to my Azure subscription?
Also, is the Ocp-Apim-Subscription-Key same as the API key 1 or my Azure subscription ID or is it something different?
API Key 2 would be needed as a backup key? Do we have any cases where we might need this second key? What if I don't generate it or use it?

GiftA-MSFT 11,161 Reputation points

2021-06-23T15:28:19.847+00:00

Yes, Ocp-Apim-Subscription-Key is the same as the API key 1 (i.e subscription key). You can use Key 1 or Key 2 (but normally Key 1) to authenticate. If you need to generate a new key for whatever reason, having two keys allows you to roll over one key while using the second key for continued access to the service. From your question, it's not clear whether you are calling the REST API, using the SDK, or using the sample labeling tool. Normally you'd need to provide your subscription key and endpoint when calling the API unless there's another required header or parameter. Please refer to our documentation for requirements, otherwise, please share the document you are referencing so we can clarify any question that you may have. Hope this helps!

Sachindra Narayan 21 Reputation points

2021-06-23T16:09:54.973+00:00

II am actually trying to use the REST API by creating an application that will consume them. I wish to know for authentication, do we need to have my subscription id and Ocp-Apim-Subscription-Key both for making the API calls? or just the Ocp-Apim-Subscription-Key key?
If yes, then in case I share my API key with any of my friend, will he/she be able to access the APIs with my key? How do we overcome that?

GiftA-MSFT 11,161 Reputation points

2021-06-23T17:36:36.477+00:00

Which form recognizer API are you referring to?

Sachindra Narayan 21 Reputation points

2021-06-23T17:38:10.097+00:00

The layout API.. i am trying to extract data from the documents, receipts, invoicing bills. etc

GiftA-MSFT 11,161 Reputation points

2021-06-23T19:42:35.467+00:00

Okay, you only need the subscription key and endpoint to authenticate. If anyone has access to your key and endpoint, the person would be able authenticate and use the service under your subscription.

Sachindra Narayan 21 Reputation points

2021-06-26T07:25:09.75+00:00

In that case, how do we go for API usage? some kind of AD based authentication for using APIs also? Do we have some use cases or sample codes on the website? or any kinda help docs?

GiftA-MSFT 11,161 Reputation points

2021-06-28T17:19:03.727+00:00

Here's the REST API documentation.
Sign in to comment

Share via

Authentication for Azure Form Recognizer

1 answer