Loading ...

REST API: Activate User | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Activate User
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 23

REST API: Activate User

0 
 /5
0 (0votes)

Activate User

PUT /api/users/activate

Activate a pending user by user ID or username. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
UserID Used in the request body Unique identifier for a particular user.
OR
UserName Used in the request body Unique name for a particular user.

Example Request - Activating a user by user ID

PUT https://myintranet.communifire.com/api/users/activate

Body:

1312

Example Request - Activating a user by username

PUT https://myintranet.communifire.com/api/users/activate

Body:

"James"

Example Response

True/false is returned as ResponseMessage.

{
    "IsError":false,
    "ResponseMessage":"True",
    "ResponseData":"1312"
}

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software