AgileApps Support Wiki

Difference between revisions of "REST API: delegation Resource"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(5 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.
:{| border="1" cellpadding="5" cellspacing="0"
:*Role list appears in the API output or considered as input only when the Switch Roles permission is enabled in company information.
! Name!!Type!!Attribute!!Required During Add!!Description!!Additional Information
:*Role ID value "-1" means ALL Roles.
|-
| id||String||Read Only||||[[Record Id]]||
|-
| first_name||String||Editable on Add/Update|||| ||
|-
| last_name||String||Editable on Add/Update|| align="center"|[[File:Checkmark.gif|link=]]|| ||
|-
| company||String||Editable on Add/Update||||||
|-
| title||String||Editable on Add/Update||||||
|-
| accessibility mode||Boolean||Editable on Add/Update||||Options:<br/>
1 - Enable accessibility mode<br/>
0 - Disable accessibility mode<br/>
||
|-
| act as delegate||Boolean||Editable on Add/Update||||Options:<br/>
1 - Delegated<br/>
0 - Not delegated<br/>
|| When delegation is enabled, logged in user can act on behalf of another user
|-
| html signature||String||Editable on Update||||
|| You are not allowed to edit signatures of other users. You are authorized to edit only your signature. You cannot fetch html_signature through Dynamic search API
|-
| time_zone||Integer||Editable on Add/Update|| align="center"|[[File:Checkmark.gif|link=]]||||''See:'' [[Time Zone Codes]]
|-
| date_format||String||Editable on Add/Update|| align="center"|[[File:Checkmark.gif|link=]]||||''See:'' [[Date#Date/Time Formats|Date/Time Formats]]
|-
| reports_to||String||Editable on Add/Update|| || User's manager/supervisor ||
|-
| employee_number||||Editable on Add/Update||||||
|-
| language||String||Editable on Add/Update||align="center"|[[File:Checkmark.gif|link=]]||||Two letter language code that is available to tenant (ex: 'en', 'es', 'hi')
|-
| email||String||Editable on Add/Update|| align="center"|[[File:Checkmark.gif|link=]] || ||
 
|-
| username||String||Editable on Add/Update|| align="center"|[[File:Checkmark.gif|link=]] || ||
|-
| site_name||String||Editable on Add/Update|| align="center"|[[File:Checkmark.gif|link=]] || Optional.
| When the name of a [[Site]] is specified, it designates the user as a ''site user'', rather than a platform user.
 
|-
| password||String||Writable on Add Only|| ||Password used to login
|
*Password is ''optional'' when creating a new user
: If not provided, a temporary password is generated and sent to the user/tenant via email
: ''Learn more: [[Manage_Email_Templates#User|Manage Email Templates - Forgot Reset Password Email]]''
*Password is ''not used'' when retrieving or updating user info
*Password is ''not returned'' as part of user data
|-
| security_question||String||Editable on Add/Update|| || This question confirms the identity of the user who has forgotten the password.||security_question parameter values are:
:1. In what city were you born? >> 1
:2. What is your first pet's name? >> 2
:3. What was your first teacher's name? >> 3
:4. Write my own security question >> 4
|-
| custom_security_question||String||Editable on Add/Update|| || This question confirms the identity of the user who has forgotten the password. || If the custom_security_question and security_answer parameters are provided while creating a user through REST API call, then the value for security_question must be '4'.
|-
| security_answer||String||Editable on Add/Update|| || The expected answer.||If the custom_security_question and security_answer parameters are provided while creating a user through REST API call, then the value for security_question must be '4'.
|-
| active||Boolean||Editable on Add/Update|| || ||
 
|-
| single_sign_on||Boolean||Editable on Add/Update||||||
|-
| sso_type||Integer||Read Only||||Type of single sign on:<br/>
1 - Delegated<br/> &nbsp; Authentication<br/>
2 - SAML<br/>
|| See: [[Single Sign On]]
|-
| federation_id||String||Read Only|| || || Used in [[Single_Sign_On#SAML|SAML]] authentication, if SAML is enabled
|-
| user_id_type ||Number||Editable on Add/Update||||1: User ID<br>2:Federated ID || Used in [[Single_Sign_On#SAML|SAML]] authentication, if SAML is enabled
 
|-
| enable_mobile ||Boolean||Editable on Add/Update|| || Allow mobile access to the platform ||
 
 
|-
| team_id ||Integer||align="center"|Editable on Add/Update|| align="center"|[[File:Checkmark.gif|link=]]||||
|-
| accessProfileId ||Integer||align="center"|Editable on Add/Update|| align="center"|[[File:Checkmark.gif|link=]]||||
|-
| phone||String||Editable on Add/Update||||||
|-
| mobile||String||Editable on Add/Update||||||
|-
|  fax  ||String||Editable on Add/Update||||||
|-
| street||String||Editable on Add/Update||||||
|-
| city ||String||Editable on Add/Update||||||
|-
| state    ||String||Editable on Add/Update||||||
|-
| zip||String||Editable on Add/Update||||||
|-
| country||String||Editable on Add/Update||||||
|-
| notify_info||Boolean||Editable on Add/Update||
|Send the Welcome email message
|When enabled, a notification email is sent (containing the [[username]], welcome and login information) when a new user is added.


Default is 1 (email is sent automatically on new user creation)
This value is not stored in the database, and is not returned by a GET.
|-
| base_currency ||String||Editable on Add/Update|||| The currency format displayed to the user, and used for data entry ||
|-
| force_password_change_on_login||Boolean||Editable on Add/Update||
|Force a password change action on first-time [[login]]
|When enabled, the User is prompted to change the password when logging in for the first time
Default is 1 (new user is forced to change password on first login)
<span id="force_security_question"></span>
|-
| force_security_question_change_on_login||Boolean||Editable on Add/Update||
| Force  the user to change their security question the next time they login.
| Default value is 1 when a user a new user record is created.
|-
| last_login ||Date||Read Only||||Date and time of last login|| [[UTC Format]]
|-
| date_last_password_change||date||Read Only|||| Date and time of last password change|| [[UTC Format]]
|-
| customer_language||String||Read Only||||Default Language, specified in [[My Information]]||
|-
| full_name||String||Read Only||||Full name of the user||
|-
| date_created||Date||Read Only||||||[[UTC Format]]
|-
| created_id||Lookup||Read Only||||||
|-
| date_modified||Date||Read Only||||||[[UTC Format]]
|-
| modified_id||Lookup||Read Only||||||
|-
| community_user_id||String||Read Only||||User's ID in the community||
|-
| auto_generated_community_user_record||Boolean||Read Only||||<true> for the initial admin user and any other user IDs automatically generated for the community||
|-
| user_type||String||Read Only||||User type: Platform user (P) or Site User (S)
|
*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]]
|-
| alias||String||Editable on Add/Update||||User's alias in the community||
|-
| description ||String||Editable on Add/Update|||| User's self-description ||rowspan="5"|
|-
| photo_id ||image||Editable on Add/Update|||| ID of the User's picture.<br>Access: REST [[REST_API:document Resource|document Resource]].
|-
| thumbnail_photo_id ||image||Editable on Add/Update||  || ID of the thumbnail image.<br>Access: REST [[REST_API:document Resource|document Resource]].
|-
| status ||String||Editable on Add/Update||||User's status
|-
| date_status_updated ||date||Editable on Add/Update||||Last date and time user's status was changed
|-
| tenant_id||String||Read Only|| || ||
* Blank when logged in as normal user in a non-community tenant.
* The ID of the host tenant, when logged in as a community user.
|-
| tenant_user_id||String||Read Only||||||
|-
| customerId||String||Read Only||||Customer ID||The ID of the tenant where the user is logged in:
* The host tenant ID, when logged in as a user for a normal (non-community) tenant.
* The ID of the community tenant, when logged in as a community user.
|-
| flag_logged_in ||Boolean||Read only|||| True if the user is logged in ||
|-
| custom field(s)||||||||[[User Fields]]||User can add fields of various type, including text, date, time, etc.
|-
| colspan="6" bgcolor="lightblue" style="height:7px" |  <!-- SPACER ROW -->
|-
| colspan="6"| '''emailNotificationOptions'''
|-
|
:* userWallPost
| Boolean|| || || True to send a notification when someone writes on the user's wall.  ||
|-
|
:* recordWallPost
| Boolean|| || || True to send a notification when someone writes on the record's wall, if the user is following that record.  ||
|-
|
:* documentWallPost
| Boolean|| || || True to send a notification when someone writes on a document wall, if the user is following that document.  ||
|-
|
:* groupWallPost
| Boolean|| || || True to send a notification when someone writes on a group wall, if the user is following that group.  ||
|-
|
:* commentOnMyPost
| Boolean|| || || True to send a notification when someone comments on one of the user's posts.  ||
|-
|
:* commentOnComment
| Boolean|| || ||True to send a notification when someone comments on one of the user's comments.  ||
|-
|
:* like
| Boolean|| || || True to send a notification when someone votes "like" on one of the user's posts.  ||
|}
===Table for API Fields===
:{| 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 400: 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||
|-
| 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 ||  
|-
|-
| principalUser|| String ||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/aawiki-src/index.php?title=REST_API:_delegation_Resource&oldid=27072"