```
public interface ClientResource
```
Author:

rodrigo.sasaki@icarros.com.br

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addDefaultClientScope(String clientScopeId)`
`void`	`addOptionalClientScope(String clientScopeId)`
`AuthorizationResource`	`authorization()`
`CredentialRepresentation`	`generateNewSecret()`
`Map<String,Integer>`	`getApplicationSessionCount()`
`ClientAttributeCertificateResource`	`getCertficateResource(String attributePrefix)`	Get representation of certificate resource
`CredentialRepresentation`	`getClientRotatedSecret()`
`List<ClientScopeRepresentation>`	`getDefaultClientScopes()`	Get default client scopes.
`String`	`getInstallationProvider(String providerId)`
`Map<String,Long>`	`getOfflineSessionCount()`
`List<UserSessionRepresentation>`	`getOfflineUserSessions(Integer firstResult, Integer maxResults)`
`List<ClientScopeRepresentation>`	`getOptionalClientScopes()`	Get optional client scopes.
`ManagementPermissionReference`	`getPermissions()`	Returns indicator if the fine grain permissions are enabled or not.
`ProtocolMappersResource`	`getProtocolMappers()`
`RoleMappingResource`	`getScopeMappings()`
`CredentialRepresentation`	`getSecret()`
`UserRepresentation`	`getServiceAccountUser()`
`List<UserSessionRepresentation>`	`getUserSessions(Integer firstResult, Integer maxResults)`
`void`	`invalidateRotatedSecret()`
`void`	`pushRevocation()`
`ClientRepresentation`	`regenerateRegistrationAccessToken()`	Generate a new registration access token for the client
`void`	`registerNode(Map<String,String> formParams)`
`void`	`remove()`
`void`	`removeDefaultClientScope(String clientScopeId)`
`void`	`removeOptionalClientScope(String clientScopeId)`
`RolesResource`	`roles()`
`ManagementPermissionReference`	`setPermissions(ManagementPermissionRepresentation status)`	Enables or disables the fine grain permissions feature.
`GlobalRequestResult`	`testNodesAvailable()`
`ClientRepresentation`	`toRepresentation()`
`void`	`unregisterNode(String node)`
`void`	`update(ClientRepresentation clientRepresentation)`

Method Detail

setPermissions
```
@PUT
@Path("/management/permissions")
@Consumes("application/json")
@Produces("application/json")
ManagementPermissionReference setPermissions(ManagementPermissionRepresentation status)
```
Enables or disables the fine grain permissions feature. Returns the updated status of the server in the ManagementPermissionReference.

Parameters:

status - status request to apply

Returns:

permission reference indicating the updated status

getPermissions
```
@GET
@Path("/management/permissions")
@Produces("application/json")
ManagementPermissionReference getPermissions()
```
Returns indicator if the fine grain permissions are enabled or not.

Returns:

current representation of the permissions feature

getProtocolMappers

@Path("protocol-mappers")
ProtocolMappersResource getProtocolMappers()

toRepresentation

@GET
@Produces("application/json")
ClientRepresentation toRepresentation()

update

@PUT
@Consumes("application/json")
void update(ClientRepresentation clientRepresentation)

remove
```
@DELETE
void remove()
```

generateNewSecret

@POST
@Path("client-secret")
@Produces("application/json")
CredentialRepresentation generateNewSecret()

getSecret

@GET
@Path("client-secret")
@Produces("application/json")
CredentialRepresentation getSecret()

regenerateRegistrationAccessToken

@Path("registration-access-token")
@POST
@Produces("application/json")
@Consumes("application/json")
ClientRepresentation regenerateRegistrationAccessToken()

Generate a new registration access token for the client

Returns:

getCertficateResource

@Path("certificates/{attr}")
ClientAttributeCertificateResource getCertficateResource(@PathParam("attr")
                                                         String attributePrefix)

Get representation of certificate resource

Parameters:: attributePrefix -
Returns:

getInstallationProvider

@GET
@Path("installation/providers/{providerId}")
String getInstallationProvider(@PathParam("providerId")
                               String providerId)

getApplicationSessionCount

@Path("session-count")
@GET
@Produces("application/json")
Map<String,Integer> getApplicationSessionCount()

getUserSessions

@Path("user-sessions")
@GET
@Produces("application/json")
List<UserSessionRepresentation> getUserSessions(@QueryParam("first")
                                                Integer firstResult,
                                                @QueryParam("max")
                                                Integer maxResults)

getOfflineSessionCount

@Path("offline-session-count")
@GET
@Produces("application/json")
Map<String,Long> getOfflineSessionCount()

getOfflineUserSessions

@Path("offline-sessions")
@GET
@Produces("application/json")
List<UserSessionRepresentation> getOfflineUserSessions(@QueryParam("first")
                                                       Integer firstResult,
                                                       @QueryParam("max")
                                                       Integer maxResults)

pushRevocation

@POST
@Path("push-revocation")
@Produces("application/json")
void pushRevocation()

getScopeMappings

@Path("/scope-mappings")
RoleMappingResource getScopeMappings()

roles
```
@Path("/roles")
RolesResource roles()
```

getDefaultClientScopes

@GET
@Produces("application/json")
@Path("default-client-scopes")
List<ClientScopeRepresentation> getDefaultClientScopes()

Get default client scopes. Only name and ids are returned.

Returns:: default client scopes

addDefaultClientScope

@PUT
@Path("default-client-scopes/{clientScopeId}")
void addDefaultClientScope(@PathParam("clientScopeId")
                           String clientScopeId)

removeDefaultClientScope

@DELETE
@Path("default-client-scopes/{clientScopeId}")
void removeDefaultClientScope(@PathParam("clientScopeId")
                              String clientScopeId)

getOptionalClientScopes

@GET
@Produces("application/json")
@Path("optional-client-scopes")
List<ClientScopeRepresentation> getOptionalClientScopes()

Get optional client scopes. Only name and ids are returned.

Returns:: optional client scopes

addOptionalClientScope

@PUT
@Path("optional-client-scopes/{clientScopeId}")
void addOptionalClientScope(@PathParam("clientScopeId")
                            String clientScopeId)

removeOptionalClientScope

@DELETE
@Path("optional-client-scopes/{clientScopeId}")
void removeOptionalClientScope(@PathParam("clientScopeId")
                               String clientScopeId)

getServiceAccountUser

@Path("/service-account-user")
@GET
@Produces("application/json")
UserRepresentation getServiceAccountUser()

registerNode

@Path("nodes")
@POST
@Consumes("application/json")
void registerNode(Map<String,String> formParams)

unregisterNode

@Path("nodes/{node}")
@DELETE
void unregisterNode(@PathParam("node")
                    String node)

testNodesAvailable

@Path("test-nodes-available")
@GET
@Produces("application/json")
GlobalRequestResult testNodesAvailable()

authorization

@Path("/authz/resource-server")
AuthorizationResource authorization()

getClientRotatedSecret

@Path("client-secret/rotated")
@GET
@Produces("application/json")
CredentialRepresentation getClientRotatedSecret()

invalidateRotatedSecret

@Path("client-secret/rotated")
@DELETE
@Produces("application/json")
@Consumes("application/json")
void invalidateRotatedSecret()

Interface ClientResource