REST API:community Resource
From AgileApps Support Wiki
(Redirected from Community REST API)
Performs actions on Community Tenant records via the REST API
Link a User to the Community
Links an existing Username to a Community User
- Learn more: Enabling a Community Tenant with Existing Users
- Method
- POST
- URI
- https://{yourDomain}/networking/community/user/operation/linkToCommunity
- Request
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<auth>
<userName>{usermame}</userName>
<password>{password}</password>
</auth>
</platform> </syntaxhighlight>
- Response
-
- On Success, a standard success message is displayed
- On Error, returns HTTP.FORBIDDEN. (can occur if the user is valid, but does not belong to the community tenant.)
Login a User to the Site
Logs a User into a community tenant.
On a new user registration, the link to the Community Tenant is automatic.
For a new Community using an established Tenant, see Enabling a Community Tenant with Existing Users
The Username must be associated with a Community User in order to login to a Community Tenant.
- Method
- GET
- URI
- https://{yourDomain}/networking/community/login/site?{query_parameters}
- Query Parameters
- {userName} - username of the site user
- {password} - password of the site user
- For more information, see: Specifying Query Parameters in REST APIs
- Response
- User details such as first name, last name, and employee number--the same as the Login resource.
Change the User Password
Changes the password of the logged in user. Password policies that are configured for the community tenant will be applicable for change password operation.
- Method
- POST
- URI
- https://{yourDomain}/networking/community/user/operation/changePassword
- Request
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<user>
<old_password>{old password}</old_password>
<password>{new password}</password>
</user>
</platform> </syntaxhighlight>
- Response
-
- On Success, a standard success message is displayed
- On Error, returns HTTP.INTERNAL_SERVER_ERROR
Additional Resources
These REST API resources are also available: