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

The following operations are supported on this resource:

  • GET - This api returns single api-access-profile
  • PUT - This api is used to modify existing api-access profile
  • PATCH - This api is used to modify existing api-access profile
  • DELETE - This api delete api-access-profile
GET /api-access-profiles/{id} Version 4

This api returns single api-access-profile.

Sample Usage

GET /api-access-profiles/{id}


  • Parameters:
    Name Type URI Type Description Required
    id Integer Path ID Y
  • 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[String]]></rule>
               </exec-rpc-rule>
         </exec-rpc-rules>
         <domain-id>Integer</domain-id>
    </api-access-profile>

  • 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" : "String"
           }
         } ,
         "domain-id" : "Integer"
       }
    }

  • Access Control

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

    PUT /api-access-profiles/{id} Version 4

    This api is used to modify existing api-access profile.

    Sample Usage

    PUT /api-access-profiles/{id}


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path ID Y
  • Sample Input XML:
    <api-access-profile>
         <name>String</name>
         <description>String</description>
         <exec-rpc-rules>
               <exec-rpc-rule>
                   <rule><![CDATA[starts-with(name(/*),'get-interface-')]]></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[starts-with(name(/*),'get-interface-')]]></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" : "starts-with(name(/*),'get-interface-')"
           }
         }
       }
    }

  • 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" : "starts-with(name(/*),'get-interface-')"
           }
         } ,
         "domain-id" : "Integer"
       }
    }

  • Access Control

    The following capabilities are required to access this API: EditApiAccessProfileCap

    PATCH /api-access-profiles/{id} Version 4

    This api is used to modify existing api-access profile.

    Sample Usage

    PATCH /api-access-profiles/{id}


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path ID Y
  • 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-->
       <replace sel="api-access-profile/name">
           <name>String</name>
       </replace>
       <replace sel="api-access-profile/description">
           <description>String</description>
       </replace>
       <replace sel="api-access-profile/exec-rpc-rules">
           <exec-rpc-rules>
             <exec-rpc-rule>
                 <rule><![CDATA[substring-before(/get-interface-information/interface-name,'-')]]></rule>
             </exec-rpc-rule>
           </exec-rpc-rules>
       </replace>
    </diff>

  • 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[substring-before(/get-interface-information/interface-name,'-')]]></rule>
               </exec-rpc-rule>
         </exec-rpc-rules>
         <domain-id>Integer</domain-id>
    </api-access-profile>

  • 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" : "substring-before(/get-interface-information/interface-name,'-')"
           }
         } ,
         "domain-id" : "Integer"
       }
    }

  • Access Control

    The following capabilities are required to access this API: EditApiAccessProfileCap

    DELETE /api-access-profiles/{id} Version 4

    This api delete api-access-profile.

    Sample Usage

    DELETE /api-access-profiles/{id}


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path ID Y

    Access Control

    The following capabilities are required to access this API: DeleteApiAccessProfileCap