/api/space/domain-management/domains/{domain-id}/users

The following operations are supported on this resource:

  • GET - Get all users belonging to the domain
  • GET - Get all users belonging to the domain
  • GET - Get all users belonging to the domain
  • POST - Associate a user with a domain
GET /domains/{domain-id}/users Version 1

Get all users belonging to the domain.

Sample Usage

GET /domains/{domain-id}/users


  • Parameters:
    Name Type URI Type Description Required
    domain-id Integer Path Domain ID Y
  • Sample Output XML:
    <users total="1" uri="/api/space/domain-management/domains/819407/users">
         <user href="/api/space/user-management/users/819514" >
               <primary-email>test@juniper.net</primary-email>
               <status>Enabled</status>
               <domains uri="/api/space/domain-management/domains/819407/users/domains">
                   <domain href="/api/space/domain-management/domains/819407" uri="/api/space/domain-management/domains/819407/users/domains/819407">
                         <id>819407</id>
                         <name>Global/child</name>
                   </domain>
               </domains>
               <last-name>User</last-name>
               <id>819514</id>
               <name>test</name>
               <first-name>Test</first-name>
         </user>
    </users>

  • Sample Output JSON:
    {
       "users" : {
         "@total" : "1" ,
         "@uri" : "/api/space/domain-management/domains/819407/users" ,
         "user" : [
           {
             "@href" : "/api/space/user-management/users/819514" ,
             "primary-email" : "test@juniper.net" ,
             "status" : "Enabled" ,
             "domains" : {
               "@uri" : "/api/space/domain-management/domains/819407/users/domains" ,
               "domain" : {
                 "@href" : "/api/space/domain-management/domains/819407" ,
                 "@uri" : "/api/space/domain-management/domains/819407/users/domains/819407" ,
                 "id" : 819407 ,
                 "name" : "Global/child"
               }
             } ,
             "last-name" : "User" ,
             "id" : 819514 ,
             "name" : "test" ,
             "first-name" : "Test"
           }
         ]
       }
    }

  • Access Control

    The following capabilities are required to access this API: AssignDomain2User, ReadDomain

    GET /domains/{domain-id}/users Version 1

    Get all users belonging to the domain.

    Sample Usage

    GET /domains/{domain-id}/users


    • Parameters:
      Name Type URI Type Description Required
      domain-id Integer Path Domain ID Y
  • Sample Output XML:
    <users total="1" uri="/api/space/domain-management/domains/819407/users">
         <user href="/api/space/user-management/users/819514" >
               <auth-mode>Local</auth-mode>
               <primary-email>test@juniper.net</primary-email>
               <status>Enabled</status>
               <domains uri="/api/space/domain-management/domains/819407/users/domains">
                   <domain href="/api/space/domain-management/domains/819407" uri="/api/space/domain-management/domains/819407/users/domains/819407">
                         <id>819407</id>
                         <name>Global/child</name>
                   </domain>
               </domains>
               <last-name>User</last-name>
               <id>819514</id>
               <name>test</name>
               <first-name>Test</first-name>
         </user>
    </users>

  • Sample Output JSON:
    {
       "users" : {
         "@total" : "1" ,
         "@uri" : "/api/space/domain-management/domains/819407/users" ,
         "user" : [
           {
             "@href" : "/api/space/user-management/users/819514" ,
             "auth-mode" : "Local" ,
             "primary-email" : "test@juniper.net" ,
             "status" : "Enabled" ,
             "domains" : {
               "@uri" : "/api/space/domain-management/domains/819407/users/domains" ,
               "domain" : {
                 "@href" : "/api/space/domain-management/domains/819407" ,
                 "@uri" : "/api/space/domain-management/domains/819407/users/domains/819407" ,
                 "id" : 819407 ,
                 "name" : "Global/child"
               }
             } ,
             "last-name" : "User" ,
             "id" : 819514 ,
             "name" : "test" ,
             "first-name" : "Test"
           }
         ]
       }
    }

  • Access Control

    The following capabilities are required to access this API: DefaultRead

    GET /domains/{domain-id}/users Version 2

    Get all users belonging to the domain.

    Sample Usage

    GET /domains/{domain-id}/users


    • Parameters:
      Name Type URI Type Description Required
      domain-id Integer Path Domain ID Y
  • Sample Output XML:
    <users total="1" uri="/api/space/domain-management/domains/819407/users">
         <user href="/api/space/user-management/users/819557" uri="/api/space/domain-management/domains/819407/users/819557">
               <id>819557</id>
               <name>test</name>
               <first-name>test</first-name>
               <last-name>user</last-name>
               <primary-email>test@juniper.net</primary-email>
               <domains>
                   <domain href="/api/space/domain-management/domains/819407" >
                         <id>819407</id>
                         <name>Global/child</name>
                         <description>Description for test user</description>
                   </domain>
               </domains>
         </user>
    </users>

  • Sample Output JSON:
    {
       "users" : {
         "@total" : "1" ,
         "@uri" : "/api/space/domain-management/domains/819407/users" ,
         "user" : {
           "@href" : "/api/space/user-management/users/819557" ,
           "@uri" : "/api/space/domain-management/domains/819407/users/819557" ,
           "id" : 819557 ,
           "name" : "test" ,
           "first-name" : "test" ,
           "last-name" : "user" ,
           "primary-email" : "test@juniper.net" ,
           "domains" : {
             "domain" : {
               "@href" : "/api/space/domain-management/domains/819407" ,
               "id" : "819407" ,
               "name" : "Global/child" ,
               "description" : "Description for test user"
             }
           }
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: AssignDomain2User, ReadDomain

    POST /domains/{domain-id}/users Version 1

    Associate a user with a domain.

    Sample Usage

    POST /domains/{domain-id}/users


    • Parameters:
      Name Type URI Type Description Required
      domain-id Integer Path Domain ID Y
  • Sample Input XML:
    <user>
         <id>819514</id>
         <name>test</name>
    </user>

  • Sample Input JSON:
    {
       "user" : {
         "id" : "819514" ,
         "name" : "test" ,
       }
    }

  • Access Control

    The following capabilities are required to access this API: AssignDomain2User