User Management API

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

The following operations are supported on this resource:

GET /api/space/user-management/profiles/{id} (v1)


This API retrieves the details about a particular remote profile.

Access Control

The following capabilities are required to access this API:
"ReadProfile"


Example Usage

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


Parameters

NameTypeURI TypeDescriptionRequired
idintPathThe ID of the remote profile for which information will be retrieved. Y

Content Types

  • Produces content types:
    application/vnd.net.juniper.space.user-management.profile+xml;version=1
    application/vnd.net.juniper.space.user-management.profile+json;version=1


  • Sample Output XML:
    <profile uri="/api/space/user-management/profiles/458785">
      <name>remoteusermanager</name>
      <description>radius profile for user management</description>
      <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",
      "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"
       }
      }
     }



PUT /api/space/user-management/profiles/{id} (v1)


This API is used to update a remote profile.

Access Control

The following capabilities are required to access this API:
"ModifyProfile"


Example Usage

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


Parameters

NameTypeURI TypeDescriptionRequired
idintPathThe ID of the remote profile to update. Y

Content Types

  • Consumes content types:
    application/vnd.net.juniper.space.user-management.profile+xml;version=1;charset=UTF-8
    application/vnd.net.juniper.space.user-management.profile+json;version=1;charset=UTF-8


  • Produces content types:
    application/vnd.net.juniper.space.user-management.profile+xml;version=1
    application/vnd.net.juniper.space.user-management.profile+json;version=1


  • Sample Input XML:
    <profile>
     <name>remoteusermanager</name>
     <description>tacacs profile for user management</description>
     <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>
     <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",
      "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",
      "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"
       }
      }
     }



DELETE /api/space/user-management/profiles/{id} (v1)


This API deletes a particular remote profile.

Access Control

The following capabilities are required to access this API:
"DeleteProfile"


Example Usage

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


Parameters

NameTypeURI TypeDescriptionRequired
idintPathThe ID of the profile to delete. Y