com.azure.identity.DeviceCodeChallenge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-identity Show documentation

This module contains client library for Microsoft Azure Identity.

There is a newer version: 1.16.0-beta.1

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.identity;

import com.azure.core.annotation.Immutable;

import java.time.Duration;

/**
 * Response returned from the STS device code endpoint containing information necessary for
 * device code flow.
 */
@Immutable
public class DeviceCodeChallenge {
    /**
     * Creates an instance of a device code challenge.
     *
     * @param userCode code which user needs to provide when authenticating at the verification URI
     * @param deviceCode code which should be included in the request for the access token
     * @param verificationUri URI where user can authenticate
     * @param expiresIn expiration time of device code in seconds
     * @param interval interval at which the STS should be polled at
     * @param message message which should be displayed to the user
     */
    public DeviceCodeChallenge(String userCode, String deviceCode, String verificationUri, long expiresIn,
                               long interval, String message) {
        this.userCode = userCode;
        this.deviceCode = deviceCode;
        this.verificationUri = verificationUri;
        this.expiresIn = Duration.ofSeconds(expiresIn);
        this.interval = Duration.ofSeconds(interval);
        this.message = message;
    }

    private final String userCode;

    private final String deviceCode;

    private final String verificationUri;

    private final Duration expiresIn;

    private final Duration interval;

    private final String message;


    /**
     * @return code which user needs to provide when authenticating at the verification URI.
     */
    public String getUserCode() {
        return userCode;
    }

    /**
     * @return code which should be included in the request for the access token.
     */
    public String getDeviceCode() {
        return deviceCode;
    }

    /**
     * @return URI where user can authenticate.
     */
    public String getVerificationUri() {
        return verificationUri;
    }

    /**
     * @return expiration time of device code.
     */
    public Duration getExpiresIn() {
        return expiresIn;
    }

    /**
     * @return interval at which the STS should be polled at.
     */
    public Duration getInterval() {
        return interval;
    }

    /**
     * @return message which should be displayed to the user.
     */
    public String getMessage() {
        return message;
    }
}