com.stormpath.sdk.client.ApiKey Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Stormpath, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.stormpath.sdk.client;

/**
 * An ApiKey represents a Stormpath customer's
 * API-specific ID and secret.  All Stormpath REST invocations must be authenticated with an ApiKey.
 * 
 * API Keys are assigned to individual people.  Never share your API Key with anyone, not even co-workers.
 *
 * @since 0.1
 * @deprecated in 1.0.RC and will be removed before 1.0 final. Use {@link com.stormpath.sdk.api.ApiKey} instead.
 */
@Deprecated
public interface ApiKey {

    /**
     * Returns the public unique identifier.  This can be publicly visible to anyone - it is not considered secure
     * information.
     *
     * @return the public unique identifier.
     * @deprecated in 1.0.RC and will be removed before 1.0 final. Use {@link com.stormpath.sdk.api.ApiKey#getId()} instead.
     */
    String getId();

    /**
     * Returns the raw SECRET used for API authentication. NEVER EVER print this value anywhere - logs,
     * files, etc.  It is TOP SECRET.  This should not be publicly visible to anyone other than the person to which
     * the ApiKey is assigned.  It is considered secure information.
     *
     * @return the raw SECRET used for API authentication.
     * @deprecated in 1.0.RC and will be removed before 1.0 final. Use {@link com.stormpath.sdk.api.ApiKey#getSecret()} instead.
     */
    String getSecret();
}