001/*-
002 * #%L
003 * Smile CDR - CDR
004 * %%
005 * Copyright (C) 2016 - 2025 Smile CDR, Inc.
006 * %%
007 * All rights reserved.
008 * #L%
009 */
010package ca.cdr.api.model.json;
011
012import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
013import com.fasterxml.jackson.annotation.JsonProperty;
014import io.swagger.v3.oas.annotations.media.Schema;
015
016/**
017 * @deprecated Use ca.cdr.api.model.json.OpenIdTokenResponseJson
018 */
019@Schema(
020                name = "OpenIdTokenResponse",
021                description =
022                                "This object represents the response from a client-credentials request to an Identity Provider's token endpoint.")
023@JsonIgnoreProperties(ignoreUnknown = true)
024public class OpenIdTokenResponseJson implements IModelJson {
025
026        /* CHECKSTYLE.OFF: RegexpSingleLine - these properties are spec compliant and should not be changed */
027
028        /**
029         * REQUIRED
030         * The token we've requested
031         */
032        @JsonProperty("access_token")
033        private String myAccessToken;
034
035        /**
036         * REQUIRED
037         * The token type ("bearer", "mac")...
038         * We should only ever receive "bearer" (as that's all we support).
039         */
040        @JsonProperty("token_type")
041        private String myTokenType;
042
043        /**
044         * RECOMMENDED
045         * The lifetime (in seconds) of the access_token.
046         * MAy or may not be included.
047         */
048        @JsonProperty("expires_in")
049        private Long myExpiration;
050
051        /**
052         * OPTIONAL
053         * Only provided if this was a refresh_token request.
054         */
055        @JsonProperty("refresh_token")
056        private String myRefreshToken;
057
058        /* CHECKSTYLE.ON: RegexpSingleLine */
059
060        public String getAccessToken() {
061                return myAccessToken;
062        }
063
064        public void setAccessToken(String theAccessToken) {
065                myAccessToken = theAccessToken;
066        }
067
068        public String getTokenType() {
069                return myTokenType;
070        }
071
072        public void setTokenType(String theTokenType) {
073                myTokenType = theTokenType;
074        }
075
076        public Long getExpiration() {
077                return myExpiration;
078        }
079
080        public void setExpiration(Long theExpiration) {
081                myExpiration = theExpiration;
082        }
083
084        public String getRefreshToken() {
085                return myRefreshToken;
086        }
087
088        public void setRefreshToken(String theRefreshToken) {
089                myRefreshToken = theRefreshToken;
090        }
091}
092
093@Deprecated(since = "2025.11.R01", forRemoval = true)
094class OpenIdTokenResponse extends OpenIdTokenResponseJson {}