REST Resources

/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="Integer" uri="/api/space/domain-management/domains/{domain-id}/users">
         <user href="/api/space/user-management/users/{id}" uri="/api/space/domain-management/domains/{domain-id}/users">
               <primary-email>String</primary-email>
               <status>String</status>
               <domains total="Integer" uri="/api/space/domain-management/domains/{domain-id}/users/domains">
                   <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{domain-id}/users/domains/{id}">
                         <id>Integer</id>
                         <name>String</name>
                   </domain>
               </domains>
               <last-name>String</last-name>
               <id>Integer</id>
               <name>String</name>
               <first-name>String</first-name>
         </user>
    </users>

  • Sample Output JSON:
    {
       "users" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/domain-management/domains/{domain-id}/users" ,
         "user" : {
           "@href" : "/api/space/user-management/users/{id}" ,
           "@uri" : "/api/space/domain-management/domains/{domain-id}/users" ,
           "primary-email" : "String" ,
           "status" : "String" ,
           "domains" : {
             "@total" : "Integer" ,
             "@uri" : "/api/space/domain-management/domains/{domain-id}/users/domains" ,
             "domain" : {
               "@href" : "/api/space/domain-management/domains/{id}" ,
               "@uri" :
               "/api/space/domain-management/domains/{domain-id}/users/domains/{id}" ,
               "id" : "Integer" ,
               "name" : "String"
             }
           } ,
           "last-name" : "String" ,
           "id" : "Integer" ,
           "name" : "String" ,
           "first-name" : "String"
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: AssignDomain2User

    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="Integer" uri="/api/space/domain-management/domains/{domain-id}/users">
         <user href="/api/space/user-management/users/{id}" uri="/api/space/domain-management/domains/{domain-id}/users">
               <primary-email>String</primary-email>
               <auth-mode>String</auth-mode>
               <status>String</status>
               <last-name>String</last-name>
               <id>Integer</id>
               <name>String</name>
               <first-name>String</first-name>
         </user>
    </users>

    • Access Control

    The following capabilities are required to access this API: AssignDomain2User

    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="Integer" uri="/api/space/domain-management/domains/{domain-id}/users">
         <user href="/api/space/user-management/users/{id}" uri="/api/space/domain-management/domains/{domain-id}/users/{id}">
               <id>Integer</id>
               <name>String</name>
               <first-name>String</first-name>
               <middle-name>String</middle-name>
               <last-name>String</last-name>
               <primary-email>String</primary-email>
               <domains total="Integer">
                   <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{domain-id}/users/{id}">
                         <id>Integer</id>
                         <name>String</name>
                         <description>String</description>
                   </domain>
               </domains>
         </user>
    </users>

  • Sample Output JSON:
    {
       "users" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/domain-management/domains/{domain-id}/users" ,
         "user" : {
           "@href" : "/api/space/user-management/users/{id}" ,
           "@uri" : "/api/space/domain-management/domains/{domain-id}/users/{id}" ,
           "id" : "Integer" ,
           "name" : "String" ,
           "first-name" : "String" ,
           "middle-name" : "String" ,
           "last-name" : "String" ,
           "primary-email" : "String" ,
           "domains" : {
             "@total" : "Integer" ,
             "domain" : {
               "@href" : "/api/space/domain-management/domains/{id}" ,
               "@uri" : "/api/space/domain-management/domains/{domain-id}/users/{id}" ,
               "id" : "Integer" ,
               "name" : "String" ,
               "description" : "String"
             }
           }
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: 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

    Access Control

    The following capabilities are required to access this API: AssignDomain2User