Home / API Documentation / Platform management / Users / Users / Sync user

`*`Sync user

Requests

HTTP request

PUT /auth/v1/users/sync

Sync users from idp

Query parameters

Name	Type	Required	Description
type	string	True	sync type, choices are: all, ldap, local

Responses

Content-Type application/json

Status code: 200

Sample response

Status is a return value for calls that don't return other objects.

{
   "apiVersion": "v1",
   "code": 200,
   "details": {},
   "kind": "Status",
   "message": "Successfully synced users",
   "metadata": {},
   "reason": "",
   "status": "Success"
 }

Parameters

Name	Type	Description
apiVersion	string	See common parameters
code	integer (int32)	Suggested HTTP return code for this status, 0 if not set. Path: code
details	object	StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. Path: details
kind	string	See common parameters
message	string	A human-readable description of the status of this operation. Path: message
metadata	object	See common parameters
reason	string	A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. Path: reason
status	string	Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Path: status

*Sync user