Contents x
    Retrieve ID token
    • 26 Mar 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Retrieve ID token

    • Updated on 26 Mar 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /v2/tenants/{tenantId}/authenticate

    Retrieve ID token to be used in the Pub/Sub API

    Header parameters
    Content-Type
    stringRequired
    Path parameters
    tenantId
    stringRequired

    The RapidIdentity Cloud tenant id

    Body parameters

    The API Key received when registering the RapidIdentity cloud tenant

    object
    apiKey
    string Required

    The api key received from registration. This key is used to receive the appropriate access token

    Responses
    200

    200 response

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    Expand All
    object
    AuthenticationResult
    object (AuthenticationResultType)
    AccessToken
    string
    ExpiresIn
    integer
    IdToken
    string
    NewDeviceMetadataType
    object (NewDeviceMetadataType)
    DeviceGroupKey
    string
    DeviceKey
    string
    RefreshToken
    string
    TokenType
    string
    ChallengeName
    string
    ChallengeParameters
    object
    Session
    string
    400

    An issue with how the request was formatted

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    Expand All
    object
    error
    object

    The error message description

    errors
    Array of object

    The more detailed information about the error message

    object
    domain
    string

    The service where the error occured. i.e. sm, idhub

    reason
    string

    The reason for the error based on Identity Automation common error codes

    message
    string

    Additional details about the error

    locationType
    string

    The specific location where the error occurred. i.e. parameter, content

    location
    string

    The higher level location of what was trying to be accessed. i.e. pullMessages, publishMessage

    code
    string

    The http status code

    message
    string

    Additional details about the error

    404

    The requested operation failed because a resource associated with the request could not be found

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    Expand All
    object
    error
    object

    The error message description

    errors
    Array of object

    The more detailed information about the error message

    object
    domain
    string

    The service where the error occured. i.e. sm, idhub

    reason
    string

    The reason for the error based on Identity Automation common error codes

    message
    string

    Additional details about the error

    locationType
    string

    The specific location where the error occurred. i.e. parameter, content

    location
    string

    The higher level location of what was trying to be accessed. i.e. pullMessages, publishMessage

    code
    string

    The http status code

    message
    string

    Additional details about the error

    503

    Unable to connect to pubsub service

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    Expand All
    object
    error
    object

    The error message description

    errors
    Array of object

    The more detailed information about the error message

    object
    domain
    string

    The service where the error occured. i.e. sm, idhub

    reason
    string

    The reason for the error based on Identity Automation common error codes

    message
    string

    Additional details about the error

    locationType
    string

    The specific location where the error occurred. i.e. parameter, content

    location
    string

    The higher level location of what was trying to be accessed. i.e. pullMessages, publishMessage

    code
    string

    The http status code

    message
    string

    Additional details about the error

    Was this article helpful?
    What's Next