Broadcom API Gateway - List Identity Providers using the Gateway Migration Utility

by
Jeremy Canfield |
Updated: February 23 2022
| Broadcom API Gateway articles
This assumes you are familiar with the basic usage of the Gateway Migration Utility. Following is an example of how to list every Identity Provider in an API Gateway.
/path/to/GatewayMigrationUtility.sh restman
-host apig.example.com
-port 8443
-username john.doe
-password f5VPX0yUJPg.m4BrjdgMv84UgktddJD3xA
-method GET
-path '1.0/identityProviders'
Or the -argFile option can be used, to reduce the number of options that are used on the command line.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/identityProviders'
Or, you can return a single Identity Provider by including the ID of the Identity Provider.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/identityProviders/da698409abc96df215cf2f80b2175a41'
Or, you can use the -query option to return a single Identity Provider by including the name of the Identity Provider.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/identityProviders'
-query 'name=Sample Identity Provider'
The -response option can be used to output the XML to a file.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/identityProviders'
-response /path/to/example.xml
Here is an example of the output that should be returned.
<l7:Item>
<l7:Name>Sample Identity Provider</l7:Name>
<l7:Id>da698409abc96df215cf2f80b2175a41</l7:Id>
<l7:Type>ID_PROVIDER_CONFIG</l7:Type>
<l7:TimeStamp>2020-08-27T17:04:52.377-05:00</l7:TimeStamp>
<l7:Link rel="self" uri="https://api.example.com:8443/restman/1.0/identityProviders/da698409abc96df215cf2f80b2175a41"/>
<l7:Resource>
<l7:IdentityProvider id="da698409abc96df215cf2f80b2175a41" version="1">
<l7:Name>Sample Identity Provider</l7:Name>
<l7:IdentityProviderType>Federated</l7:IdentityProviderType>
<l7:Properties>
<l7:Property key="certificateValidation">
<l7:StringValue>Validate Certificate Path</l7:StringValue>
</l7:Property>
<l7:Property key="enableCredentialType.saml">
<l7:BooleanValue>false</l7:BooleanValue>
</l7:Property>
<l7:Property key="enableCredentialType.x509">
<l7:BooleanValue>true</l7:BooleanValue>
</l7:Property>
</l7:Properties>
<l7:Extension>
<l7:FederatedIdentityProviderDetail>
<l7:CertificateReferences resourceUri="http://ns.l7tech.com/2010/04/gateway-management/trustedCertificates">
<l7:Reference id="da698409abc96df215cf2f80b2175a41"/>
</l7:CertificateReferences>
</l7:FederatedIdentityProviderDetail>
</l7:Extension>
</l7:IdentityProvider>
</l7:Resource>
</l7:Item>
Did you find this article helpful?
If so, consider buying me a coffee over at