Identity Provider API, REST: User.ConvertToExternal

Field

Description

userId

string

Required field. ID of the user to convert.

Field

Description

externalId

string

Required field. External identifier to associate with the user.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

ConvertToExternalUserMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

User

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

userId

string

ID of the user being converted.

externalId

string

External identifier being associated with the user.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

id

string

Unique identifier of the user.
This ID is generated automatically when the user is created.

userpoolId

string

ID of the userpool this user belongs to.
To get the userpool ID, make a UserpoolService.List request.

status

enum (Status)

Current status of the user.
Determines whether the user can authenticate and access the system.

• STATUS_UNSPECIFIED: The status is not specified.
• CREATING: The user is in the process of being created.
• ACTIVE: The user is active and can authenticate.
  Active users have full access to the system according to their permissions.
• SUSPENDED: The user is suspended and cannot authenticate.
  Suspended users retain their data but cannot access the system.
• DELETING: The user is in the process of being deleted.
  This is a transitional state before the user is completely removed from the system.

username

string

Username used for authentication.
Usually in the format of an email address.

fullName

string

User's full name (display name).
This is typically shown in the UI and used for identification purposes.

givenName

string

User's first name.
Part of the user's profile information.

familyName

string

User's last name.
Part of the user's profile information.

email

string

User's email address.

phoneNumber

string

User's phone number.

createdAt

string (date-time)

Timestamp when the user was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Timestamp when the user was last updated.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

externalId

string

External identifier for federation with external identity systems.
This ID can be used to link this user with an account in an external system.