org.cloudfoundry.uaa.clients

Class CreateClientRequest

java.lang.Object

org.cloudfoundry.uaa.clients.CreateClientRequest

All Implemented Interfaces:

IdentityZoned

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class CreateClientRequest
extends Object

The request payload for the create client

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateClientRequest.Builder Builds instances of type CreateClientRequest.

Method Summary

Modifier and Type	Method and Description
static CreateClientRequest.Builder	builder() Creates a builder for CreateClientRequest.
boolean	equals(Object another) This instance is equal to all instances of CreateClientRequest that have equal attribute values.
Long	getAccessTokenValidity() The access token validity
List<String>	getAllowedProviders() A list of origin keys (alias) for identity providers the client is limited to.
Boolean	getApprovalsDeleted() Were the approvals deleted for the client, and an audit event sent
List<String>	getAuthorities() Scopes that the client is able to grant when creating a client
List<GrantType>	getAuthorizedGrantTypes() List of grant types that can be used to obtain a token with this client.
List<String>	getAutoApproves() Scopes that do not require user approval
String	getClientId() Client identifier, unique within identity zone
String	getClientSecret() A secret string used for authenticating as this client
String	getCreatedWith() What scope the bearer token had when client was created
String	getIdentityZoneId() Returns the identity zone id
String	getIdentityZoneSubdomain() Returns the identity zone subdomain
String	getName() A human readable name for the client
List<String>	getRedirectUriPatterns() Allowed URI pattern for redirect during authorization
Long	getRefreshTokenValidity() The refresh token validity
List<String>	getResourceIds() Resources the client is allowed access to
List<String>	getScopes() Scopes allowed for the client
String	getTokenSalt() A random string used to generate the client’s revokation key.
int	hashCode() Computes a hash code from attributes: identityZoneId, identityZoneSubdomain, accessTokenValidity, allowedProviders, approvalsDeleted, authorities, authorizedGrantTypes, autoApproves, clientId, clientSecret, createdWith, name, redirectUriPatterns, refreshTokenValidity, resourceIds, scopes, tokenSalt.
String	toString() Prints the immutable value CreateClientRequest with attribute values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getIdentityZoneId

public String getIdentityZoneId()

Returns the identity zone id

Returns:

the identity zone id

getIdentityZoneSubdomain

public String getIdentityZoneSubdomain()

Returns the identity zone subdomain

Returns:

the identity zone subdomain

getAccessTokenValidity

public Long getAccessTokenValidity()

The access token validity

getAllowedProviders

public List<String> getAllowedProviders()

A list of origin keys (alias) for identity providers the client is limited to. Null implies any identity provider is allowed.

getApprovalsDeleted

public Boolean getApprovalsDeleted()

Were the approvals deleted for the client, and an audit event sent

getAuthorities

public List<String> getAuthorities()

Scopes that the client is able to grant when creating a client

getAuthorizedGrantTypes

public List<GrantType> getAuthorizedGrantTypes()

List of grant types that can be used to obtain a token with this client. Can include authorization_code, password, implicit, and/or client_credentials.

getAutoApproves

public List<String> getAutoApproves()

Scopes that do not require user approval

getClientId

public String getClientId()

Client identifier, unique within identity zone

getClientSecret

public String getClientSecret()

A secret string used for authenticating as this client

getCreatedWith

public String getCreatedWith()

What scope the bearer token had when client was created

getName

public String getName()

A human readable name for the client

getRedirectUriPatterns

public List<String> getRedirectUriPatterns()

Allowed URI pattern for redirect during authorization

getRefreshTokenValidity

public Long getRefreshTokenValidity()

The refresh token validity

getResourceIds

public List<String> getResourceIds()

Resources the client is allowed access to

getScopes

public List<String> getScopes()

Scopes allowed for the client

getTokenSalt

public String getTokenSalt()

A random string used to generate the client’s revokation key. Change this value to revoke all active tokens for the client

equals

public boolean equals(Object another)

This instance is equal to all instances of CreateClientRequest that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: identityZoneId, identityZoneSubdomain, accessTokenValidity, allowedProviders, approvalsDeleted, authorities, authorizedGrantTypes, autoApproves, clientId, clientSecret, createdWith, name, redirectUriPatterns, refreshTokenValidity, resourceIds, scopes, tokenSalt.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CreateClientRequest with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static CreateClientRequest.Builder builder()

Creates a builder for CreateClientRequest.

 CreateClientRequest.builder()
    .identityZoneId(String | null) // nullable identityZoneId
    .identityZoneSubdomain(String | null) // nullable identityZoneSubdomain
    .accessTokenValidity(Long | null) // nullable accessTokenValidity
    .allowedProviders(List<String> | null) // nullable allowedProviders
    .approvalsDeleted(Boolean | null) // nullable approvalsDeleted
    .authorities(List<String> | null) // nullable authorities
    .authorizedGrantTypes(List<org.cloudfoundry.uaa.tokens.GrantType> | null) // nullable authorizedGrantTypes
    .autoApproves(List<String> | null) // nullable autoApproves
    .clientId(String) // required clientId
    .clientSecret(String | null) // nullable clientSecret
    .createdWith(String | null) // nullable createdWith
    .name(String | null) // nullable name
    .redirectUriPatterns(List<String> | null) // nullable redirectUriPatterns
    .refreshTokenValidity(Long | null) // nullable refreshTokenValidity
    .resourceIds(List<String> | null) // nullable resourceIds
    .scopes(List<String> | null) // nullable scopes
    .tokenSalt(String | null) // nullable tokenSalt
    .build();
 

Returns:

A new CreateClientRequest builder