/api/space/user-management/api-access-profiles

The following operations are supported on this resource:

  • GET - This api returns list of available api-access-profiles
  • POST - This api add new api-access-profile to space
  • PATCH - Multiple adds/deletes to the apiaccessprofilemos collection
GET /api-access-profiles Version 4

This api returns list of available api-access-profiles.

Sample Usage

GET /api-access-profiles


  • Sample Output XML:
    <api-access-profiles total="Integer" uri="/api/space/user-management/api-access-profiles">
         <api-access-profile
               href="/api/space/user-management/api-access-profiles/{id}" uri="/api/space/user-management/api-access-profiles/{id}">
               <id>Integer</id>
               <name>String</name>
               <description>String</description>
         </api-access-profile>
    </api-access-profiles>

  • Sample Output JSON:
    {
       "api-access-profiles" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/user-management/api-access-profiles" ,
         "api-access-profile" : {
           "@href" : "/api/space/user-management/api-access-profiles/{id}" ,
           "@uri" : "/api/space/user-management/api-access-profiles/{id}" ,
           "id" : "Integer" ,
           "name" : "String" ,
           "description" : "String"
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ApiAccessMgmtCap

    POST /api-access-profiles Version 4

    This api add new api-access-profile to space.

    Sample Usage

    POST /api-access-profiles


  • Sample Input XML:
    <api-access-profile>
         <name>String</name>
         <description>String</description>
         <exec-rpc-rules>
               <exec-rpc-rule>
                   <rule><![CDATA[/get-system-information]]></rule>
               </exec-rpc-rule>
         </exec-rpc-rules>
    </api-access-profile>

  • Sample Output XML:
    <api-access-profile
         href="/api/space/user-management/api-access-profiles/{id}" uri="/api/space/user-management/api-access-profiles/{id}">
         <id>Integer</id>
         <name>String</name>
         <description>String</description>
         <predefined>Boolean</predefined>
         <exec-rpc-rules>
               <exec-rpc-rule>
                   <rule><![CDATA[/get-system-information]]></rule>
               </exec-rpc-rule>
         </exec-rpc-rules>
         <domain-id>Integer</domain-id>
    </api-access-profile>

  • Sample Input JSON:
    {
       "api-access-profile" : {
         "name" : "String" ,
         "description" : "String" ,
         "exec-rpc-rules" : {
           "exec-rpc-rule" : {
             "rule" : "/get-system-information"
           }
         }
       }
    }

  • Sample Output JSON:
    {
       "api-access-profile" : {
         "@href" : "/api/space/user-management/api-access-profiles/{id}" ,
         "@uri" : "/api/space/user-management/api-access-profiles/{id}" ,
         "id" : "Integer" ,
         "name" : "String" ,
         "description" : "String" ,
         "predefined" : "Boolean" ,
         "exec-rpc-rules" : {
           "exec-rpc-rule" : {
             "rule" : "/get-system-information"
           }
         } ,
         "domain-id" : "Integer"
       }
    }

  • Access Control

    The following capabilities are required to access this API: CreateApiAccessProfileCap

    PATCH /api-access-profiles Version 4

    Multiple adds/deletes to the apiaccessprofilemos collection.

    Sample Usage

    PATCH /api-access-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://http://www.rfc-editor.org/rfc/rfc5261.txt-->
       <add sel="api-access-profiles">
           <api-access-profile>
             <name>String</name>
             <description>String</description>
           </api-access-profile>
       </add>
       <!-- or -->
       <remove sel="api-access-profiles/api-access-profile[@some attribute='some value']"/>
       <!-- or using element selection-->
       <remove sel="api-access-profiles/api-access-profile[some element='some value']"/>
    </diff>

  • Access Control

    The following capabilities are required to access this API: CreateApiAccessProfileCap, DeleteApiAccessProfileCap, EditApiAccessProfileCap, ViewApiAccessProfileCap, ApiAccessMgmtCap