org.finra.herd.sdk.api

Class UserNamespaceAuthorizationApi

java.lang.Object

org.finra.herd.sdk.api.UserNamespaceAuthorizationApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class UserNamespaceAuthorizationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UserNamespaceAuthorizationApi()
UserNamespaceAuthorizationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
UserNamespaceAuthorization	userNamespaceAuthorizationCreateUserNamespaceAuthorization(UserNamespaceAuthorizationCreateRequest userNamespaceAuthorizationCreateRequest) createUserNamespaceAuthorization <p>Creates a new user namespace authorization.</p> <p>The user ID field may be prefixed with a wildcard token character \"*\" to authorize multiple users access to the namespace.
UserNamespaceAuthorization	userNamespaceAuthorizationDeleteUserNamespaceAuthorization(String userId, String namespace) deleteUserNamespaceAuthorization Deletes an existing user namespace authorization by key.
UserNamespaceAuthorization	userNamespaceAuthorizationGetUserNamespaceAuthorization(String userId, String namespace) getUserNamespaceAuthorization Gets an existing user namespace authorization by key.
UserNamespaceAuthorizations	userNamespaceAuthorizationGetUserNamespaceAuthorizationsByNamespace(String namespace) getUserNamespaceAuthorizationsByNamespace Gets a list of user namespace authorizations for the specified namespace.
UserNamespaceAuthorizations	userNamespaceAuthorizationGetUserNamespaceAuthorizationsByUserId(String userId) getUserNamespaceAuthorizationsByUserId Gets a list of user namespace authorizations for the specified user.
UserNamespaceAuthorization	userNamespaceAuthorizationUpdateUserNamespaceAuthorization(String userId, String namespace, UserNamespaceAuthorizationUpdateRequest userNamespaceAuthorizationUpdateRequest) updateUserNamespaceAuthorization Updates an existing user namespace authorization by key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserNamespaceAuthorizationApi

public UserNamespaceAuthorizationApi()

UserNamespaceAuthorizationApi

public UserNamespaceAuthorizationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

userNamespaceAuthorizationCreateUserNamespaceAuthorization

public UserNamespaceAuthorization userNamespaceAuthorizationCreateUserNamespaceAuthorization(UserNamespaceAuthorizationCreateRequest userNamespaceAuthorizationCreateRequest)
                                                                                      throws ApiException

createUserNamespaceAuthorization <p>Creates a new user namespace authorization.</p> <p>The user ID field may be prefixed with a wildcard token character \"*\" to authorize multiple users access to the namespace. The wildcard only works for as a prefix to match the suffix of the user ID. If the wildcard appears anywhere other than the prefix, the user ID must match as-is. For example:</p> <ul> <li>john.doe@domain.com - only authorizes user with ID \"john.doe@domain.com\"</li> <li>*@domain.com - authorizes users that has the suffix \"@domain.com\"</li> <li>* - authorizes all users</li> <li>john.doe* - only authorizes user with ID \"john.doe*\"</li> </ul> <p>Requires GRANT permission on namespace</p>

Parameters:

userNamespaceAuthorizationCreateRequest - the information needed to create the user namespace authorization

Returns:

UserNamespaceAuthorization

Throws:

ApiException

userNamespaceAuthorizationGetUserNamespaceAuthorizationsByNamespace

public UserNamespaceAuthorizations userNamespaceAuthorizationGetUserNamespaceAuthorizationsByNamespace(String namespace)
                                                                                                throws ApiException

getUserNamespaceAuthorizationsByNamespace Gets a list of user namespace authorizations for the specified namespace.

Parameters:

namespace - the namespace

Returns:

UserNamespaceAuthorizations

Throws:

ApiException

userNamespaceAuthorizationGetUserNamespaceAuthorizationsByUserId

public UserNamespaceAuthorizations userNamespaceAuthorizationGetUserNamespaceAuthorizationsByUserId(String userId)
                                                                                             throws ApiException

getUserNamespaceAuthorizationsByUserId Gets a list of user namespace authorizations for the specified user.

Parameters:

userId - the user id

Returns:

UserNamespaceAuthorizations

Throws:

ApiException

userNamespaceAuthorizationGetUserNamespaceAuthorization

public UserNamespaceAuthorization userNamespaceAuthorizationGetUserNamespaceAuthorization(String userId,
                                                                                          String namespace)
                                                                                   throws ApiException

getUserNamespaceAuthorization Gets an existing user namespace authorization by key. <p>Requires READ permission on namespace</p>

Parameters:

userId - the user id

namespace - the namespace

Returns:

UserNamespaceAuthorization

Throws:

ApiException

userNamespaceAuthorizationUpdateUserNamespaceAuthorization

public UserNamespaceAuthorization userNamespaceAuthorizationUpdateUserNamespaceAuthorization(String userId,
                                                                                             String namespace,
                                                                                             UserNamespaceAuthorizationUpdateRequest userNamespaceAuthorizationUpdateRequest)
                                                                                      throws ApiException

updateUserNamespaceAuthorization Updates an existing user namespace authorization by key. <p>Requires GRANT permission on namespace</p>

Parameters:

userId - the user id

namespace - the namespace

userNamespaceAuthorizationUpdateRequest - the information needed to update the user namespace authorization

Returns:

UserNamespaceAuthorization

Throws:

ApiException

userNamespaceAuthorizationDeleteUserNamespaceAuthorization

public UserNamespaceAuthorization userNamespaceAuthorizationDeleteUserNamespaceAuthorization(String userId,
                                                                                             String namespace)
                                                                                      throws ApiException

deleteUserNamespaceAuthorization Deletes an existing user namespace authorization by key. <p>Requires GRANT permission on namespace</p>

Parameters:

userId - the user id

namespace - the namespace

Returns:

UserNamespaceAuthorization

Throws:

ApiException