Assign service identity's authenticating identity provider
    • PDF

    Assign service identity's authenticating identity provider

    • PDF

    Article summary

    Post
    /api/workload/users/{targetUserId}/identity-provider
    Security
    HTTP
    Type bearer
    Path parameters
    targetUserId
    stringRequired

    The random 20 alphanumeric string id of the service identity user.

    Body parameters
    Expand All
    object

    The existing identity provider to update.

    idpId
    integer (int32) Required

    the identifier of the identity provider to assign to the service identity

    tokenDuration
    integer (int32) Required

    duration in seconds the identity provider tokens issued for the service identity is valid for after initial token verification.

    mappingAttributes
    Array of object (MappingAttribute) Required

    mapped custom attribute values.

    object

    mapped custom attribute value.

    attrId
    string
    values
    Array of string
    string
    Responses
    200

    Successfully assigned identity provider to service identity.

    Expand All
    object

    model of the workload identity provider currently assigned to a service identity

    idp
    object (IdentityProvider)
    idpType
    string
    id
    integer (int32)
    name
    string
    description
    string
    attributesMap
    Array of object (AttributeMap)

    Provider's identity attributes mapped to Britive service identity custom attributes.

    object

    Single identity provider attribute mapped to service identity custom attribute

    idpAttr
    string
    userAttr
    string
    validationWindow
    integer (int32)

    The amount of time in seconds, after the token has been issued/signed, Britive will attempt to validate the unverified token. Outside this window, token validation will fail.

    maxDuration
    integer (int32)

    The maximum number of hours the client can request the AWS token be valid.

    id
    integer (int32)
    name
    string
    description
    string
    attributesMap
    Array of object (AttributeMap)

    Provider's identity attributes mapped to Britive service identity custom attributes.

    object

    Single identity provider attribute mapped to service identity custom attribute

    idpAttr
    string
    userAttr
    string
    validationWindow
    integer (int32)

    The amount of time in seconds, after the token has been issued/signed, Britive will attempt to validate the unverified token. Outside this window, token validation will fail.

    issuerUrl
    string
    allowedAudiences
    Array of string
    string
    tokenDuration
    integer (int32)

    duration in seconds the identity provider tokens issued for the service identity is valid for after initial token verification.

    mappingAttributes
    Array of object (MappingAttribute)

    mapped custom attribute values.

    object

    mapped custom attribute value.

    attrId
    string
    values
    Array of string
    string

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.