Bootstrap FreeKB - Broadcom API Gateway - List Identity Provider users using the Gateway Migration Utility
Broadcom API Gateway - List Identity Provider users using the Gateway Migration Utility

Updated:   |  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 the users in the Identity Provider with ID da698409abc96df215cf2f80b2175a41.

/path/to/GatewayMigrationUtility.sh restman
-host apig.example.com
-port 8443
-username john.doe
-password f5VPX0yUJPg.m4BrjdgMv84UgktddJD3xA
-method GET
-path '1.0/identityProviders/da698409abc96df215cf2f80b2175a41/users'

 

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/da698409abc96df215cf2f80b2175a41/users'

 

Or, a single user can be returned by including the user ID.

/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/identityProviders/da698409abc96df215cf2f80b2175a41/users/a51237cc16c31b69edd66bb1e7243219'

 

Or, you can use the -query option to return a single user by including the name of the user.

/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/identityProviders/da698409abc96df215cf2f80b2175a41/users'
-query 'name=john.doe'

 

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/da698409abc96df215cf2f80b2175a41/users'
-response /path/to/idp_users.xml

 

Something like this should be returned.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<l7:List xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
    <l7:Name>USER List</l7:Name>
    <l7:Type>List</l7:Type>
    <l7:TimeStamp>2020-08-28T06:20:35.478-05:00</l7:TimeStamp>
    <l7:Link rel="self" uri="https://api.example.com:8443/restman/1.0/identityProviders/da698409abc96df215cf2f80b2175a41/users"/>
    <l7:Link rel="template" uri="https://api.example.com:8443/restman/1.0/identityProviders/da698409abc96df215cf2f80b2175a41/users/template"/>
    <l7:Item>
        <l7:Name>john.doe</l7:Name>
        <l7:Id>a51237cc16c31b69edd66bb1e7243219</l7:Id>
        <l7:Type>USER</l7:Type>
        <l7:TimeStamp>2020-08-28T06:20:35.478-05:00</l7:TimeStamp>
        <l7:Link rel="self" uri="https://api.example.com:8443/restman/1.0/identityProviders/da698409abc96df215cf2f80b2175a41/users/a51237cc16c31b69edd66bb1e7243219"/>
        <l7:Resource>
            <l7:User providerId="da698409abc96df215cf2f80b2175a41" id="a51237cc16c31b69edd66bb1e7243219">
                <l7:Login>john.doe</l7:Login>
                <l7:FirstName>John</l7:FirstName>
                <l7:LastName>Doe</l7:LastName>
                <l7:Email></l7:Email>
                <l7:Properties>
                    <l7:Property key="accountExpiration">
                        <l7:LongValue>-1</l7:LongValue>
                    </l7:Property>
                    <l7:Property key="enabled">
                        <l7:BooleanValue>true</l7:BooleanValue>
                    </l7:Property>
                    <l7:Property key="name">
                        <l7:StringValue>john.doe</l7:StringValue>
                    </l7:Property>
                </l7:Properties>
            </l7:User>
        </l7:Resource>
    </l7:Item>
</l7:List>

 




Did you find this article helpful?

If so, consider buying me a coffee over at Buy Me A Coffee



Comments


Add a Comment


Please enter b5c15b in the box below so that we can be sure you are a human.