[]
        
(Showing Draft Content)

ExternalUser

ExternalUser

[GET] /api/v1/externalusers/{providerName}

Get all users of the specified external login provider.

Parameters

Name Type Located In Description
providerNameRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/externalusers/{providerName}/mappings

Get all mapped users' information of the specified external login provider.

Parameters

Name Type Located In Description
providerNameRequired string path

Response

Status Code: 200

Success

[POST] /api/v1/externalusers/{providerName}/mappings

Update the user mappings' information of the specified external login provider.

Parameters

Name Type Located In Description
providerNameRequired string path

Request Schema

MappingUserModel

Response

Status Code: 200

Success

[DELETE] /api/v1/externalusers/mappings/{externalUserId}

Delete the specified external user mapping information.

Parameters

Name Type Located In Description
externalUserIdRequired string path

Response

Status Code: 200

Success

Models

Ƭ MappingUserModel

Name Type Description Example
mappingMode UserMappingMode
providerNameNullable string
userMappingsNullable ManualMappingUserModel

Ƭ UserMappingMode

Enum:

  • Manual
  • MappingByEmail
  • MappingByMobile

Ƭ ManualMappingUserModel

Name Type Description Example
externalUserIdNullable string
innerUserNameNullable string