AgileApps Support Wiki Pre Release

Difference between revisions of "REST API: delegation Resource"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(4 intermediate revisions by the same user not shown)
Line 167: Line 167:
:* In this object, Boolean fields accept either 1/0 or TRUE/FALSE
:* In this object, Boolean fields accept either 1/0 or TRUE/FALSE
:* Because there are so many fields, and so many of them can be empty, empty fields generally are ''not returned'' as part of user data. However, they can still be specified for an update.
:* Because there are so many fields, and so many of them can be empty, empty fields generally are ''not returned'' as part of user data. However, they can still be specified for an update.
:*Role list appears in the API output or considered as input only when the Switch Roles permission is enabled in company information.
:*Role ID value "-1" means ALL Roles.


:{| border="1" cellpadding="5" cellspacing="0"
:{| border="1" cellpadding="5" cellspacing="0"
! Name !! Type !! Description !! Additional Information
! Name !! Type !! Description !! Additional Information
|-
|-
| application || String|| application identifier ||  
| Active || Boolean|| Indicates if a delegation is active or inactive. || TRUE means a delegation is active and FALSE means the delegatee is not shown in the list of delegatees during the run time Become Delegate action.
|-
|-
| uri || ''attribute'' || A link to the application || Use the link in a browser to go to the application
| applicationId || String|| The ID of an application ||  
|-
|-
| displayValue || ''attribute'' || Name displayed in the GUI ||
| createdID || Lookup || This is the user ID bean  || User ID
|-
|-
| type || String || User type. For example, platform user or site user ||
| dateCreated || Date || Date of delegation creation or resource creation ||  
*Platform Users are licensed [[Users]] who have a [[Login]] (to a [[Tenant]], which is provided by an [[ISV]]
*Platform Users can be automatically included as Site Users (''Learn More: [[Community Tenant#Configure a Community Tenant|Configure a Community Tenant]]'')
*Site Users are registered through a [[Sites|Site]]
|-
|-
| dateModified || Date || Date the delegation role is applied ||  
| dateModified || Date || Date the delegation role is applied || [[UTC Format]]
|-
|-
| delegateAccessProfile || Boolean || Allows you to manage the delegation when set to TRUE. ||  
| delegateAccessProfile || Boolean || Allows you to manage the delegation when set to TRUE. ||  
Line 188: Line 187:
| delegatee || String || User receiving the delegation from a Principal User. ||  
| delegatee || String || User receiving the delegation from a Principal User. ||  
|-
|-
| principalUser|| String ||User delegating the profile to a Delegate User ||  
| id|| String ||The ID for this record||  
|-
|-
| principalUser|| String ||User delegating the profile to a Delegate User ||  
| modifiedId|| Lookup ||The ID of the record used for updating the resource|| User ID
|-
| principalUser|| String || The user delegating the profile to a Delegate User ||
|-
| roleId|| String || The particular role of the principal user which is delegated to the delegatee||  
|}
|}


<noinclude>
<noinclude>


[[Category:REST API|user Resource]]
[[Category:REST API|Session Management Resources]]
</noinclude>
</noinclude>

Latest revision as of 12:11, 14 August 2018

Performs actions related to delegating your own profile and those of your direct reports to a proxy user. A proxy user should be able to perform the same activities as his or her supervisor depending on the role(s) delegated to him or her.

Access Permissions

Notepad.png

Note: Users should have the Manage Delegations permissions.

Add a User for Delegation

Allows you to add users to the Delegated users list.

Method
POST
URI
https://{yourDomain}/networking/rest/delegation/
Request
<syntaxhighlight lang="html4strict" enclose="div">

<platform> <delegation> <active>false</active> <applicationId>08455b174ee14b26859c44c60f2ceb7b</applicationId> <createdId> <content>b2c6fb3b59ba4f9a9c212f20be284df5</content> <displayValue>Fix Fix2</displayValue> <type>USER</type> <uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri> </createdId> <dateCreated>2018-07-26T00:46:41.000Z</dateCreated> <dateModified>2018-07-26T06:09:09.000Z</dateModified> <delegateAccessProfile>false</delegateAccessProfile> <delegatee> <content>b2c6fb3b59ba4f9a9c212f20be284df5</content> <displayValue>Fix Fix2</displayValue> <type>USER</type> <uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri> </delegatee> <id>ee35804e4c2942b999d8b5521e786fd7</id> <modifiedId> <content>b2c6fb3b59ba4f9a9c212f20be284df5</content> <displayValue>Fix Fix2</displayValue> <type>USER</type> <uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri> </modifiedId> <prinicpalUser> <content>792a8e8725104cb58e5d337ea730f59b</content> <displayValue>Fit fit</displayValue> <type>USER</type> <uri>https://localhost/networking/rest/user/792a8e8725104cb58e5d337ea730f59b</uri> </prinicpalUser> <roleId> <content>18d2099643e64deab4a174dc113a5174</content> <displayValue>Agent</displayValue> <type>ROLE</type> <uri>https://localhost/networking/rest/role/18d2099643e64deab4a174dc113a5174</uri> </roleId> <roleId> <content>c7b03526a90c44cdbbfdaa4e5564c6a9</content> <displayValue>Manager</displayValue> <type>ROLE</type> <uri>https://localhost/networking/rest/role/c7b03526a90c44cdbbfdaa4e5564c6a9</uri> </roleId> </delegation> </platform> </syntaxhighlight>

Response
<syntaxhighlight lang="html4strict" enclose="div">

<platform> <message> 0 <description>Success</description> <id><delegationId></id> </message> </platform> </syntaxhighlight>

See also: REST API:Error Codes

Retrieve the Delegated Users list

Retrieves the list of delegated users.

Method
GET
URI
https://{yourDomain}/networking/rest/delegation/<delegationId>
Response
<syntaxhighlight lang="html4strict" enclose="div">

<platform> <delegation> <active>false</active> <applicationId>08455b174ee14b26859c44c60f2ceb7b</applicationId> <createdId> <content>b2c6fb3b59ba4f9a9c212f20be284df5</content> <displayValue>Fix Fix2</displayValue> <type>USER</type> <uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri> </createdId> <dateCreated>2018-07-26T00:46:41.000Z</dateCreated> <dateModified>2018-07-26T06:09:09.000Z</dateModified> <delegateAccessProfile>false</delegateAccessProfile> <delegatee> <content>b2c6fb3b59ba4f9a9c212f20be284df5</content> <displayValue>Fix Fix2</displayValue> <type>USER</type> <uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri> </delegatee> <id>ee35804e4c2942b999d8b5521e786fd7</id> <modifiedId> <content>b2c6fb3b59ba4f9a9c212f20be284df5</content> <displayValue>Fix Fix2</displayValue> <type>USER</type> <uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri> </modifiedId> <prinicpalUser> <content>792a8e8725104cb58e5d337ea730f59b</content> <displayValue>Fit fit</displayValue> <type>USER</type> <uri>https://localhost/networking/rest/user/792a8e8725104cb58e5d337ea730f59b</uri> </prinicpalUser> <roleId> <content>18d2099643e64deab4a174dc113a5174</content> <displayValue>Agent</displayValue> <type>ROLE</type> <uri>https://localhost/networking/rest/role/18d2099643e64deab4a174dc113a5174</uri> </roleId> <roleId> <content>c7b03526a90c44cdbbfdaa4e5564c6a9</content> <displayValue>Manager</displayValue> <type>ROLE</type> <uri>https://localhost/networking/rest/role/c7b03526a90c44cdbbfdaa4e5564c6a9</uri> </roleId> </delegation> <message> 0 <description>Success</description> </message> </platform> </syntaxhighlight>

See also: REST API:Error Codes

Update the List of Delegated Users

Allows you to update the list of delegated users.

Method
PUT
URI
https://{yourDomain}/networking/rest/delegation/<delegationId>
Response
<syntaxhighlight lang="html4strict" enclose="div">

<platform> <message> 0 <description>Success</description> <id><delegationId></id> </message> </platform> </syntaxhighlight>

See also: REST API:Error Codes


Delete a Delegated User

Allows you to delete a delegated user.

Method
DELETE
URI
https://{yourDomain}/networking/rest/delegation/<delegationId>
Response
<syntaxhighlight lang="html4strict" enclose="div">

<platform> <message> 0 <description>Success</description> </message> </platform> </syntaxhighlight>

See also: REST API:Error Codes

Fields

Notes:
  • In this object, Boolean fields accept either 1/0 or TRUE/FALSE
  • Because there are so many fields, and so many of them can be empty, empty fields generally are not returned as part of user data. However, they can still be specified for an update.
  • Role list appears in the API output or considered as input only when the Switch Roles permission is enabled in company information.
  • Role ID value "-1" means ALL Roles.
Name Type Description Additional Information
Active Boolean Indicates if a delegation is active or inactive. TRUE means a delegation is active and FALSE means the delegatee is not shown in the list of delegatees during the run time Become Delegate action.
applicationId String The ID of an application
createdID Lookup This is the user ID bean User ID
dateCreated Date Date of delegation creation or resource creation
dateModified Date Date the delegation role is applied UTC Format
delegateAccessProfile Boolean Allows you to manage the delegation when set to TRUE.
delegatee String User receiving the delegation from a Principal User.
id String The ID for this record
modifiedId Lookup The ID of the record used for updating the resource User ID
principalUser String The user delegating the profile to a Delegate User
roleId String The particular role of the principal user which is delegated to the delegatee
Retrieved from "https://agileappscloud.info/aadev-src/index.php?title=REST_API:_delegation_Resource&oldid=27072"