Skip to main content

Add an IDP authenticator to a user

POST 
/resources/v3alpha/users/:id/idps

Add a new identity provider (IDP) authenticator to an existing user. This will allow the user to authenticate with the provided IDP.

Request​

Path Parameters

    id stringrequired

    unique identifier of the user.

Query Parameters

    instance.id string
    instance.domain string
    organization.orgId string
    organization.orgDomain string

Body

required

    idpId ID of the identity provider (string)required

    Possible values: non-empty and <= 200 characters

    userId ID of the user provided by the identity provider (string)required

    Possible values: non-empty and <= 200 characters

    userName stringrequired

    Possible values: non-empty and <= 200 characters

    Username of the user provided by the identity provider.

Responses​

IDP authenticator successfully added

Schema

    details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string
Loading...