com.yodlee.api.model.auth.ApiKeyOutput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yodlee-api-model-beta Show documentation

Yodlee API Model Beta is the stage version

There is a newer version: 1.0.29.beta1

Show newest version

/**
 * Copyright (c) 2019 Yodlee, Inc. All Rights Reserved.
 *
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
package com.yodlee.api.model.auth;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"key", "publicKey", "expiryTime"})
public class ApiKeyOutput extends AbstractApiKey {

	@ApiModelProperty(value = "ApiKey or the issuer key used to generate the JWT token for authentication."//
			+ "

"//
			+ "Endpoints:"//
			+ ""//
			+ "GET /auth/apiKey"//
			+ "POST /auth/apiKey"//
			+ "")
	@JsonProperty("key")
	private String key;

	@ApiModelProperty(value = "The date on which the apiKey was created for the customer."//
			+ "

"//
			+ "Endpoints:"//
			+ ""//
			+ "GET /auth/apiKey"//
			+ "POST /auth/apiKey"//
			+ "")
	@JsonProperty("createdDate")
	private String createdDate;

	@ApiModelProperty(value = "Time in seconds after which the JWT token created for users expires."//
			+ "

"//
			+ "Endpoints:"//
			+ ""//
			+ "GET /auth/apiKey"//
			+ "POST /auth/apiKey"//
			+ "")
	@JsonProperty("expiresIn")
	private Long expiresIn;

	/**
	 * ApiKey or the issuer key used to generate the JWT token for authentication. 

	 * 

	 * Endpoints:
	 * 
	 * GET /auth/apiKey
	 * POST /auth/apiKey
	 * 
	 * 
	 * @return key
	 */
	public String getKey() {
		return key;
	}

	/**
	 * Time in seconds after which the JWT token created for users expires. 

	 * 

	 * Endpoints:
	 * 
	 * GET /auth/apiKey
	 * POST /auth/apiKey
	 * 
	 * 
	 * @return expiresIn
	 */
	public Long getExpiresIn() {
		return expiresIn;
	}

	/**
	 * The date on which the apiKey was created for the customer. 

	 * 

	 * Endpoints:
	 * 
	 * GET /auth/apiKey
	 * POST /auth/apiKey
	 * 
	 * 
	 * @return createdDate
	 */
	public String getCreatedDate() {
		return createdDate;
	}

	@Override
	public String toString() {
		return "ApiKeyOutput [key=" + key + ", issueDate=" + createdDate + ", expiryTime=" + expiresIn + "]";
	}
}