B2C pass custom header to REST API

Question

Hi @AmanpreetSingh-MSFT ,

Could you please help me to find documentation or sample custom profile example where I can find way to pass custom header to REST API?

In my case we are calling REST API to validate user credentials and REST API is secured through API key, in order to make successful calls I need to pass following header:

"X-API-Key" : "API KEY VALUE"

Another details I wanted to check if there is anyway to automate this behavior, for example: If I store my API key in key-vault can I get it from key vault and add it into custom policy header, so that key rotation scenario will be handled automatically?

Thanks for your help.

Thanks for your help.

Answer 1

Hi @Vikas Tiwari ·

Please refer to the example below:

<TechnicalProfile Id="RestApi">  
    <DisplayName>Restful Open Source Claims Provider</DisplayName>  
    <Protocol Name="Proprietary" Handler="Web.TPEngine.Providers.RestfulProvider, Web.TPEngine, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />  
    <Metadata>  
        <Item Key="ServiceUrl">http://myapi.example.com/api/User/formbody</Item>  
        <Item Key="AuthenticationType">ApiKeyHeader</Item>  
    </Metadata>  
    <CryptographicKeys>  
        <Key Id="x-api-key" StorageReferenceId="KeyIdInStorage" />  
    </CryptographicKeys>  
</TechnicalProfile>  

The key here is "AuthenticationType" and the CryptographicKey Id= which sets the header key. Let me know if it helps.

-----------------------------------------------------------------------------------------------------------

Please "Accept the answer" if the information helped you. This will help us and others in the community as well.

Answer 2

You can send all the input claims as headers setting the Metadata\SendClaimsIn element value to Header.