[]
        
(Showing Draft Content)

ExternalUser

ExternalUser

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

Parameters

Name In Type
providerNameRequired path string

Get all users of the specified external login provider.

Responses

[200] Success

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

Parameters

Name In Type
providerNameRequired path string

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

Responses

[200] Success

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

Parameters

Name In Type
providerNameRequired path string

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

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

MappingUserModel

Responses

[200] Success

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

Parameters

Name In Type
externalUserIdRequired path string

Delete the specified external user mapping information.

Responses

[200] Success

Models

Ƭ MappingUserModel

Name Type
mappingMode UserMappingMode
providerNameNullable string
userMappingsNullable Array<ManualMappingUserModel>

Ƭ UserMappingMode

Enum:

  • Manual
  • MappingByEmail
  • MappingByMobile

Ƭ ManualMappingUserModel

Name Type
externalUserIdNullable string
innerUserNameNullable string