/api/space/user-management/profiles/{id}

The following operations are supported on this resource:

  • GET - Get a single remote profile
  • PUT - Replace/Update a remote profile
  • DELETE - Delete a remote profile
GET /profiles/{id} Version 1

This API retrieves the details about a particular remote profile.

Sample Usage

GET /profiles/{id}


  • Parameters:
    Name Type URI Type Description Required
    id int Path The ID of the remote profile for which information will be retrieved. Y
  • Sample Output XML:
    <profile uri="/api/space/user-management/profiles/458785">
      <name>remoteusermanager</name>
      <description>radius profile for user management</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/458785/roles">
        <role uri="/api/space/user-management/profiles/458785/roles/65696"
              href= "/api/space/user-management/roles/65696">
          <name>userAdmin</name>
        </role>
      </roles>
    </profile>

  • Sample Output JSON:
    {
      "profile":{
           "@uri": "/api/space/user-management/profiles/458785",
           "name":"remoteusermanager",
           "description": "radius profile for user management",
        "api-access-profile": {
            "@href":"/api/space/user-management/api-access-profiles/12345",
                 "id": 12345,
                  "name":"apiaccessprofile"
              },
           "roles":{
                "@uri": "/api/space/user-management/profiles/458785/roles",
                "role":{
                   ;   "@uri":"/api/space/user-management/profiles/458785/roles/65696",
                   ;   "@href":"/api/space/user-management/roles/65696",
                   ;   "name":"userAdmin"
                }
           }
      }
    }

  • Access Control

    The following capabilities are required to access this API: ReadProfile

    PUT /profiles/{id} Version 1

    This API is used to update a remote profile.

    Sample Usage

    PUT /profiles/{id}


    • Parameters:
      Name Type URI Type Description Required
      id int Path   Y
  • Sample Input XML:
    <profile>
       <name>remoteusermanager</name>
       <description>tacacs profile for user management</description>
       <api-access-profile href="/api/space/user-management/api-access-profiles/12345" />
       <roles>
         <role href="/api/space/user-management/roles/65696" />
       </roles>
    </profile>

  • Sample Output XML:
    <profile uri="/api/space/user-management/profiles/458785">
     <name>remoteusermanager</name>
     <description>tacacs profile for user management</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/458785/roles">
      <role uri="/api/space/user-management/profiles/458785/roles/65696"
             href= "/api/space/user-management/roles/65696">
       <name>userAdmin</name>
      </role>
     </roles>
    </profile>

  • Sample Input JSON:
    {
      "profile":{
           "name":"remoteusermanager",
           "description": "tacacs profile for user management",
        "api-access-profile": {
            "@href":"/api/space/user-management/api-access-profiles/12345"
              },
           "roles":{
               "role":{
                     "@href": "/api/space/user-management/roles/65696"
               }
           }
      }
    }

  • Sample Output JSON:
    {
      "profile":{
           "@uri": "/api/space/user-management/profiles/458785",
           "name":"remoteusermanager",
           "description": "tacacs profile for user management",
        "api-access-profile": {
            "@href":"/api/space/user-management/api-access-profiles/12345",
                 "id": 12345,
                  "name":"apiaccessprofile"
              },
           "roles":{
                "@uri": "/api/space/user-management/profiles/458785/roles",
                "role":{
                   ;   "@uri":"/api/space/user-management/profiles/458785/roles/65696",
                   ;   "@href":"/api/space/user-management/roles/65696",
                   ;   "name":"userAdmin"
                }
           }
      }

  • Access Control

    The following capabilities are required to access this API: ModifyProfile

    DELETE /profiles/{id} Version 1

    This API deletes a particular remote profile.

    Sample Usage

    DELETE /profiles/{id}


    • Parameters:
      Name Type URI Type Description Required
      id int Path The ID of the profile to delete. Y

    Access Control

    The following capabilities are required to access this API: DeleteProfile