REST Resources

/api/space/user-management/profiles

The following operations are supported on this resource:

  • GET - Get all remote profiles
  • POST - Create a new remote profile
  • PATCH - Multiple deletes to the profiles collection
GET /profiles Version 1

Get all remote profiles. Remote profiles are used in RADIUS system administration.

Sample Usage

GET /profiles


  • Sample Output XML:
    <profiles size="2" uri="/api/space/user-management/profiles">
      <profile key="458785" href="/api/space/user-management/profiles/458785"
        uri="/api/space/user-management/profiles/458785">
        <name>remoteusermanager</name>
        <description>radius profile for user management</description>
      </profile>
      <profile key="458791" href="/api/space/user-management/profiles/458791"
        uri="/api/space/user-management/profiles/458791">
        <name>remotedevicescriptmanager</name>
        <description>radius profile for device script management</description>
      </profile>
    </profiles>

  • Sample Output JSON:
    {
      "profiles":{
            "@size":"2",
            "@uri": "/api/space/user-management/profiles",
            "profile":[
                   {
                     "@key":"458785",
                     "@href":"/api/space/user-management/profiles/458785",
                     "@uri":"/api/space/user-management/profiles/458785",
                     "name":"remoteusermanager",
                     "description":"radius profile for user management"
                   },
                   {
                     "@key":"458791",
                     "@href":"/api/space/user-management/profiles/458791",
                     "@uri":"/api/space/user-management/profiles/458791",
                     "name":"remotedevicescriptmanager",
                     "description":"radius profile for device script management"
                   }
            ]
      }
    }

    • Access Control

    The following capabilities are required to access this API: ReadProfile

    POST /profiles Version 1

    This API is used to add a remote profile with the provided roles.

    Sample Usage

    POST /profiles


  • Sample Input XML:
    <profile>
      <name>remotesystemadmin</name>
      <description>remote profile for radius system administrator</description>
       <api-access-profile href="/api/space/user-management/api-access-profiles/12345" />
      <roles>
        <role href="/api/space/user-management/roles/65699" />
      </roles>
        <domains>
              <domain href="/api/space/domain-management/domains/{id}"/>
        </domains>
    </profile>

  • Sample Output XML:
    <profile uri="/api/space/user-management/profiles/458803">
      <name>remotesystemadmin</name>
      <description>remote profile for radius system administrator   </description>
       <api-access-profile href="/api/space/user-management/api-access-profiles/12345" >
              <id>12345</id>
            <name>apiaccessprofile</name>
       </api-access-profile>
      <roles uri="/api/space/user-management/profiles/458803/roles">
        <role uri="/api/space/user-management/profiles/458803/roles/65699"
              href= "/api/space/user-management/roles/65699">
          <name>systemAdmin</name>
        </role>
      </roles>
         <domains uri="/api/space/user-management/profiles/domains">
               <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/user-management/profiles/domains/{id}">
                   <id>Integer</id>
                   <name>String</name>
               </domain>
         </domains>
    </profile>

  • Sample Input JSON:
    {
      "profile":{
          "name":"remotesystemadmin",
          "description": "remote profile for radius system administrator",
        "api-access-profile": {
            "@href":"/api/space/user-management/api-access-profiles/12345"
              },
          "roles": {
               "role": {
                     "@href":"/api/space/user-management/roles/65699"
               }
          },
         "domains" : {
           "domain" : {
             "@href":"/api/space/domain-management/domains/{id}"
            }
          }
      }
    }

  • Sample Output JSON:
    {
      "profile":{
           "@uri": "/api/space/user-management/profiles/458851",
           "name":"remotesystemadmin",
           "description": "remote profile for radius system administrator",
        "api-access-profile": {
            "@href":"/api/space/user-management/api-access-profiles/12345",
                 "id": 12345,
                  "name":"apiaccessprofile"
              },
           "roles":{
                "@uri": "/api/space/user-management/profiles/458851/roles",
                "role":{
                     "@uri":"/api/space/user-management/profiles/458851/roles/65699",
                     "@href":"/api/space/user-management/roles/65699",
                     "name":"systemAdmin"
                }
           },
         "domains" : {
           "@uri" : "/api/space/user-management/profiles/domains" ,
           "domain" : {
             "@href" : "/api/space/domain-management/domains/{id}" ,
             "@uri" : "/api/space/user-management/profiles/domains/{id}" ,
             "id" : "Integer" ,
             "name" : "String"
           }
         }
      }
    }

    • Access Control

    The following capabilities are required to access this API: CreateProfile

    PATCH /profiles Version 1

    Multiple deletes to the profiles collection.

    Sample Usage

    PATCH /profiles


  • Sample Patch XML:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <diff>
       <!--What you see below are just samples of patch operations that may be performed on this DTO.-->
       <!--For more information about patch document format please look at http://www.rfc-editor.org/rfc/rfc5261.txt-->
       <add>
         <profile>
           <name>remotesystemadmin</name>
           <description>remote profile for radius system administrator</description>
           <api-access-profile href="/api/space/user-management/api-access-profiles/1671249" />
           <roles>
             <role href="/api/space/user-management/roles/393798" />
           </roles>
           <domains>
             <domain href="/api/space/domain-management/domains/32768"/>
           </domains>
         </profile>
       </add>
       <!-- or using element selection-->
       <remove sel="profiles/profile[some element='some value']"/>
    </diff>

    • Access Control

    The following capabilities are required to access this API: DeleteProfile