Documentation ¶
Index ¶
- func AcceptInviteInvitationPath(acceptCode string) string
- func AddCollaboratorsPath(spaceID uuid.UUID, identityID string) string
- func AddManyCollaboratorsPath(spaceID uuid.UUID) string
- func AssignRoleResourceRolesPath(resourceID string) string
- func AuditTokenPath() string
- func AuthorizeAuthorizePath() string
- func BanNamedusersPath(username string) string
- func CallbackAuthorizePath() string
- func CallbackLoginPath() string
- func CreateInviteInvitationPath(inviteTo string) string
- func CreateOrganizationPath() string
- func CreateSpacePath(spaceID uuid.UUID) string
- func CreateTeamPath() string
- func CreateUsersPath() string
- func DeactivateNamedusersPath(username string) string
- func DeleteResourcePath(resourceID string) string
- func DeleteSpacePath(spaceID uuid.UUID) string
- func DeleteTokenPath() string
- func DeprovisionNamedusersPath(username string) string
- func ExchangeTokenPath() string
- func HasScopeResourceRolesPath(resourceID string, scopeName string) string
- func KeysTokenPath() string
- func LinkCallbackTokenPath() string
- func LinkTokenPath() string
- func ListAssignedByRoleNameResourceRolesPath(resourceID string, roleName string) string
- func ListAssignedResourceRolesPath(resourceID string) string
- func ListCollaboratorsPath(spaceID uuid.UUID) string
- func ListOrganizationPath() string
- func ListResourcesUserPath() string
- func ListRolesPath() string
- func ListTeamPath() string
- func ListTeamsSpacePath(spaceID string) string
- func ListTokensUsersPath(id string) string
- func ListUsersPath() string
- func LoginLoginPath() string
- func LogoutLogoutPath() string
- func Logoutv2LogoutPath() string
- func RefreshTokenPath() string
- func RegisterResourcePath() string
- func RemoveCollaboratorsPath(spaceID uuid.UUID, identityID string) string
- func RemoveManyCollaboratorsPath(spaceID uuid.UUID) string
- func RescindInviteInvitationPath(inviteTo string) string
- func RetrieveTokenPath() string
- func RevokeAllTokensUsersPath(id string) string
- func ScopesResourcePath(resourceID string) string
- func SendEmailVerificationCodeUsersPath() string
- func ShowClustersPath() string
- func ShowOpenidConfigurationPath() string
- func ShowResourcePath(resourceID string) string
- func ShowStatusPath() string
- func ShowUserPath() string
- func ShowUserinfoPath() string
- func ShowUsersPath(id string) string
- func StatusTokenPath() string
- func UpdateUsersPath() string
- func UsersSearchPath() string
- func VerifyEmailUsersPath() string
- type AddManyCollaboratorsPayload
- type AssignRoleArray
- type AssignRoleData
- type AssignRoleResourceRolesPayload
- type AuthToken
- type Client
- func (c *Client) AcceptInviteInvitation(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) AddCollaborators(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) AddManyCollaborators(ctx context.Context, path string, payload *AddManyCollaboratorsPayload, ...) (*http.Response, error)
- func (c *Client) AssignRoleResourceRoles(ctx context.Context, path string, payload *AssignRoleResourceRolesPayload, ...) (*http.Response, error)
- func (c *Client) AuditToken(ctx context.Context, path string, resourceID string) (*http.Response, error)
- func (c *Client) AuthorizeAuthorize(ctx context.Context, path string, clientID string, redirectURI string, ...) (*http.Response, error)
- func (c *Client) BanNamedusers(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) CallbackAuthorize(ctx context.Context, path string, code string, state string) (*http.Response, error)
- func (c *Client) CallbackLogin(ctx context.Context, path string, code *string, state *string) (*http.Response, error)
- func (c *Client) CreateInviteInvitation(ctx context.Context, path string, payload *CreateInviteInvitationPayload, ...) (*http.Response, error)
- func (c *Client) CreateOrganization(ctx context.Context, path string, payload *CreateOrganizationPayload, ...) (*http.Response, error)
- func (c *Client) CreateSpace(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) CreateTeam(ctx context.Context, path string, payload *CreateTeamPayload, ...) (*http.Response, error)
- func (c *Client) CreateUsers(ctx context.Context, path string, payload *CreateUsersPayload, ...) (*http.Response, error)
- func (c *Client) DeactivateNamedusers(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) DecodeAssignRoleArray(resp *http.Response) (*AssignRoleArray, error)
- func (c *Client) DecodeAuthToken(resp *http.Response) (*AuthToken, error)
- func (c *Client) DecodeClusterList(resp *http.Response) (*ClusterList, error)
- func (c *Client) DecodeCreateInvitationRequest(resp *http.Response) (*CreateInvitationRequest, error)
- func (c *Client) DecodeCreateOrganizationRequest(resp *http.Response) (*CreateOrganizationRequest, error)
- func (c *Client) DecodeCreateOrganizationResponse(resp *http.Response) (*CreateOrganizationResponse, error)
- func (c *Client) DecodeCreateTeamRequest(resp *http.Response) (*CreateTeamRequest, error)
- func (c *Client) DecodeCreateTeamResponse(resp *http.Response) (*CreateTeamResponse, error)
- func (c *Client) DecodeCreateUser(resp *http.Response) (*CreateUser, error)
- func (c *Client) DecodeExternalToken(resp *http.Response) (*ExternalToken, error)
- func (c *Client) DecodeExternalTokenStatus(resp *http.Response) (*ExternalTokenStatus, error)
- func (c *Client) DecodeIdentityResourceScope(resp *http.Response) (*IdentityResourceScope, error)
- func (c *Client) DecodeIdentityTeamArray(resp *http.Response) (*IdentityTeamArray, error)
- func (c *Client) DecodeIdentityroles(resp *http.Response) (*Identityroles, error)
- func (c *Client) DecodeJSONAPIErrors(resp *http.Response) (*JSONAPIErrors, error)
- func (c *Client) DecodeOauthToken(resp *http.Response) (*OauthToken, error)
- func (c *Client) DecodeOpenIDConfiguration(resp *http.Response) (*OpenIDConfiguration, error)
- func (c *Client) DecodeOrganizationArray(resp *http.Response) (*OrganizationArray, error)
- func (c *Client) DecodePublicKeys(resp *http.Response) (*PublicKeys, error)
- func (c *Client) DecodeRPTToken(resp *http.Response) (*RPTToken, error)
- func (c *Client) DecodeRedirectLocation(resp *http.Response) (*RedirectLocation, error)
- func (c *Client) DecodeRegisterResource(resp *http.Response) (*RegisterResource, error)
- func (c *Client) DecodeRegisterResourceResponse(resp *http.Response) (*RegisterResourceResponse, error)
- func (c *Client) DecodeResource(resp *http.Response) (*Resource, error)
- func (c *Client) DecodeResourceScopes(resp *http.Response) (*ResourceScopes, error)
- func (c *Client) DecodeResourceScopesData(resp *http.Response) (*ResourceScopesData, error)
- func (c *Client) DecodeRoles(resp *http.Response) (*Roles, error)
- func (c *Client) DecodeSpaceResource(resp *http.Response) (*SpaceResource, error)
- func (c *Client) DecodeStatus(resp *http.Response) (*Status, error)
- func (c *Client) DecodeTeamArray(resp *http.Response) (*TeamArray, error)
- func (c *Client) DecodeUpdateUser(resp *http.Response) (*UpdateUser, error)
- func (c *Client) DecodeUpdateUserIDList(resp *http.Response) (*UpdateUserIDList, error)
- func (c *Client) DecodeUser(resp *http.Response) (*User, error)
- func (c *Client) DecodeUserArray(resp *http.Response) (*UserArray, error)
- func (c *Client) DecodeUserInfo(resp *http.Response) (*UserInfo, error)
- func (c *Client) DecodeUserList(resp *http.Response) (*UserList, error)
- func (c *Client) DecodeUserResourcesList(resp *http.Response) (*UserResourcesList, error)
- func (c *Client) DecodeUserTokenArray(resp *http.Response) (*UserTokenArray, error)
- func (c *Client) DeleteResource(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) DeleteSpace(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) DeleteToken(ctx context.Context, path string, for_ string) (*http.Response, error)
- func (c *Client) DeprovisionNamedusers(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ExchangeToken(ctx context.Context, path string, payload *TokenExchange, contentType string) (*http.Response, error)
- func (c *Client) HasScopeResourceRoles(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) KeysToken(ctx context.Context, path string, format *string) (*http.Response, error)
- func (c *Client) LinkCallbackToken(ctx context.Context, path string, code string, state string) (*http.Response, error)
- func (c *Client) LinkToken(ctx context.Context, path string, for_ string, redirect *string) (*http.Response, error)
- func (c *Client) ListAssignedByRoleNameResourceRoles(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ListAssignedResourceRoles(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ListCollaborators(ctx context.Context, path string, pageLimit *int, pageOffset *string, ...) (*http.Response, error)
- func (c *Client) ListOrganization(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ListResourcesUser(ctx context.Context, path string, type_ string) (*http.Response, error)
- func (c *Client) ListRoles(ctx context.Context, path string, resourceType *string) (*http.Response, error)
- func (c *Client) ListTeam(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ListTeamsSpace(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ListTokensUsers(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ListUsers(ctx context.Context, path string, filterEmail *string, filterUsername *string, ...) (*http.Response, error)
- func (c *Client) LoginLogin(ctx context.Context, path string, apiClient *string, redirect *string, ...) (*http.Response, error)
- func (c *Client) LogoutLogout(ctx context.Context, path string, redirect *string, referer *string) (*http.Response, error)
- func (c *Client) Logoutv2Logout(ctx context.Context, path string, redirect *string, referer *string) (*http.Response, error)
- func (c *Client) NewAcceptInviteInvitationRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewAddCollaboratorsRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewAddManyCollaboratorsRequest(ctx context.Context, path string, payload *AddManyCollaboratorsPayload, ...) (*http.Request, error)
- func (c *Client) NewAssignRoleResourceRolesRequest(ctx context.Context, path string, payload *AssignRoleResourceRolesPayload, ...) (*http.Request, error)
- func (c *Client) NewAuditTokenRequest(ctx context.Context, path string, resourceID string) (*http.Request, error)
- func (c *Client) NewAuthorizeAuthorizeRequest(ctx context.Context, path string, clientID string, redirectURI string, ...) (*http.Request, error)
- func (c *Client) NewBanNamedusersRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewCallbackAuthorizeRequest(ctx context.Context, path string, code string, state string) (*http.Request, error)
- func (c *Client) NewCallbackLoginRequest(ctx context.Context, path string, code *string, state *string) (*http.Request, error)
- func (c *Client) NewCreateInviteInvitationRequest(ctx context.Context, path string, payload *CreateInviteInvitationPayload, ...) (*http.Request, error)
- func (c *Client) NewCreateOrganizationRequest(ctx context.Context, path string, payload *CreateOrganizationPayload, ...) (*http.Request, error)
- func (c *Client) NewCreateSpaceRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewCreateTeamRequest(ctx context.Context, path string, payload *CreateTeamPayload, ...) (*http.Request, error)
- func (c *Client) NewCreateUsersRequest(ctx context.Context, path string, payload *CreateUsersPayload, ...) (*http.Request, error)
- func (c *Client) NewDeactivateNamedusersRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewDeleteResourceRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewDeleteSpaceRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewDeleteTokenRequest(ctx context.Context, path string, for_ string) (*http.Request, error)
- func (c *Client) NewDeprovisionNamedusersRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewExchangeTokenRequest(ctx context.Context, path string, payload *TokenExchange, contentType string) (*http.Request, error)
- func (c *Client) NewHasScopeResourceRolesRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewKeysTokenRequest(ctx context.Context, path string, format *string) (*http.Request, error)
- func (c *Client) NewLinkCallbackTokenRequest(ctx context.Context, path string, code string, state string) (*http.Request, error)
- func (c *Client) NewLinkTokenRequest(ctx context.Context, path string, for_ string, redirect *string) (*http.Request, error)
- func (c *Client) NewListAssignedByRoleNameResourceRolesRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewListAssignedResourceRolesRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewListCollaboratorsRequest(ctx context.Context, path string, pageLimit *int, pageOffset *string, ...) (*http.Request, error)
- func (c *Client) NewListOrganizationRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewListResourcesUserRequest(ctx context.Context, path string, type_ string) (*http.Request, error)
- func (c *Client) NewListRolesRequest(ctx context.Context, path string, resourceType *string) (*http.Request, error)
- func (c *Client) NewListTeamRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewListTeamsSpaceRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewListTokensUsersRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewListUsersRequest(ctx context.Context, path string, filterEmail *string, filterUsername *string, ...) (*http.Request, error)
- func (c *Client) NewLoginLoginRequest(ctx context.Context, path string, apiClient *string, redirect *string, ...) (*http.Request, error)
- func (c *Client) NewLogoutLogoutRequest(ctx context.Context, path string, redirect *string, referer *string) (*http.Request, error)
- func (c *Client) NewLogoutv2LogoutRequest(ctx context.Context, path string, redirect *string, referer *string) (*http.Request, error)
- func (c *Client) NewRefreshTokenRequest(ctx context.Context, path string, payload *RefreshToken, contentType string) (*http.Request, error)
- func (c *Client) NewRegisterResourceRequest(ctx context.Context, path string, payload *RegisterResourcePayload, ...) (*http.Request, error)
- func (c *Client) NewRemoveCollaboratorsRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewRemoveManyCollaboratorsRequest(ctx context.Context, path string, payload *RemoveManyCollaboratorsPayload, ...) (*http.Request, error)
- func (c *Client) NewRescindInviteInvitationRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewRetrieveTokenRequest(ctx context.Context, path string, for_ string, forcePull *bool) (*http.Request, error)
- func (c *Client) NewRevokeAllTokensUsersRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewScopesResourceRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewSendEmailVerificationCodeUsersRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewShowClustersRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewShowOpenidConfigurationRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewShowResourceRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewShowStatusRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewShowUserRequest(ctx context.Context, path string, ifModifiedSince *string, ifNoneMatch *string) (*http.Request, error)
- func (c *Client) NewShowUserinfoRequest(ctx context.Context, path string) (*http.Request, error)
- func (c *Client) NewShowUsersRequest(ctx context.Context, path string, ifModifiedSince *string, ifNoneMatch *string) (*http.Request, error)
- func (c *Client) NewStatusTokenRequest(ctx context.Context, path string, for_ string, forcePull *bool) (*http.Request, error)
- func (c *Client) NewUpdateUsersRequest(ctx context.Context, path string, payload *UpdateUsersPayload, ...) (*http.Request, error)
- func (c *Client) NewUsersSearchRequest(ctx context.Context, path string, q string, pageLimit *int, pageOffset *string) (*http.Request, error)
- func (c *Client) NewVerifyEmailUsersRequest(ctx context.Context, path string, code string) (*http.Request, error)
- func (c *Client) RefreshToken(ctx context.Context, path string, payload *RefreshToken, contentType string) (*http.Response, error)
- func (c *Client) RegisterResource(ctx context.Context, path string, payload *RegisterResourcePayload, ...) (*http.Response, error)
- func (c *Client) RemoveCollaborators(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) RemoveManyCollaborators(ctx context.Context, path string, payload *RemoveManyCollaboratorsPayload, ...) (*http.Response, error)
- func (c *Client) RescindInviteInvitation(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) RetrieveToken(ctx context.Context, path string, for_ string, forcePull *bool) (*http.Response, error)
- func (c *Client) RevokeAllTokensUsers(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ScopesResource(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) SendEmailVerificationCodeUsers(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) SetJWTSigner(signer goaclient.Signer)
- func (c *Client) ShowClusters(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ShowOpenidConfiguration(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ShowResource(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ShowStatus(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ShowUser(ctx context.Context, path string, ifModifiedSince *string, ifNoneMatch *string) (*http.Response, error)
- func (c *Client) ShowUserinfo(ctx context.Context, path string) (*http.Response, error)
- func (c *Client) ShowUsers(ctx context.Context, path string, ifModifiedSince *string, ifNoneMatch *string) (*http.Response, error)
- func (c *Client) StatusToken(ctx context.Context, path string, for_ string, forcePull *bool) (*http.Response, error)
- func (c *Client) UpdateUsers(ctx context.Context, path string, payload *UpdateUsersPayload, ...) (*http.Response, error)
- func (c *Client) UsersSearch(ctx context.Context, path string, q string, pageLimit *int, pageOffset *string) (*http.Response, error)
- func (c *Client) VerifyEmailUsers(ctx context.Context, path string, code string) (*http.Response, error)
- type ClusterData
- type ClusterList
- type CreateIdentityDataAttributes
- type CreateInvitationRequest
- type CreateInviteInvitationPayload
- type CreateOrganizationPayload
- type CreateOrganizationRequest
- type CreateOrganizationResponse
- type CreateTeamPayload
- type CreateTeamRequest
- type CreateTeamResponse
- type CreateUser
- type CreateUserData
- type CreateUsersPayload
- type ExternalToken
- type ExternalTokenStatus
- type GenericData
- type GenericLinks
- type IdentityResourceScope
- type IdentityResourceScopeData
- type IdentityRolesData
- type IdentityTeamArray
- type IdentityTeamData
- type Identityroles
- type Invitee
- type JSONAPIError
- type JSONAPIErrors
- type JSONAPILink
- type OauthToken
- type OpenIDConfiguration
- type OrganizationArray
- type OrganizationData
- type PagingLinks
- type PublicKeys
- type RPTToken
- type RedirectLocation
- type RedirectURL
- type RefreshToken
- type RegisterResource
- type RegisterResourcePayload
- type RegisterResourceResponse
- type RelationGeneric
- type RelationGenericList
- type RemoveManyCollaboratorsPayload
- type Resource
- type ResourceScopes
- type ResourceScopesData
- type Roles
- type RolesData
- type Space
- type SpaceResource
- type SpaceResourceData
- type Status
- type TeamArray
- type TeamData
- type TokenData
- type TokenExchange
- type TokenPrivilegeData
- type UpdateIdentityDataAttributes
- type UpdateUser
- type UpdateUserData
- type UpdateUserID
- type UpdateUserIDList
- type UpdateUsersPayload
- type User
- type UserArray
- type UserData
- type UserDataAttributes
- type UserInfo
- type UserList
- type UserListMeta
- type UserResourceData
- type UserResourcesList
- type UserTokenArray
- type UserTokenData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AcceptInviteInvitationPath ¶
AcceptInviteInvitationPath computes a request path to the acceptInvite action of invitation.
func AddCollaboratorsPath ¶
AddCollaboratorsPath computes a request path to the add action of collaborators.
func AddManyCollaboratorsPath ¶
AddManyCollaboratorsPath computes a request path to the add-many action of collaborators.
func AssignRoleResourceRolesPath ¶
AssignRoleResourceRolesPath computes a request path to the assignRole action of resource_roles.
func AuditTokenPath ¶
func AuditTokenPath() string
AuditTokenPath computes a request path to the audit action of token.
func AuthorizeAuthorizePath ¶
func AuthorizeAuthorizePath() string
AuthorizeAuthorizePath computes a request path to the authorize action of authorize.
func BanNamedusersPath ¶
BanNamedusersPath computes a request path to the ban action of namedusers.
func CallbackAuthorizePath ¶
func CallbackAuthorizePath() string
CallbackAuthorizePath computes a request path to the callback action of authorize.
func CallbackLoginPath ¶
func CallbackLoginPath() string
CallbackLoginPath computes a request path to the callback action of login.
func CreateInviteInvitationPath ¶
CreateInviteInvitationPath computes a request path to the createInvite action of invitation.
func CreateOrganizationPath ¶
func CreateOrganizationPath() string
CreateOrganizationPath computes a request path to the create action of organization.
func CreateSpacePath ¶
CreateSpacePath computes a request path to the create action of space.
func CreateTeamPath ¶
func CreateTeamPath() string
CreateTeamPath computes a request path to the create action of team.
func CreateUsersPath ¶
func CreateUsersPath() string
CreateUsersPath computes a request path to the create action of users.
func DeactivateNamedusersPath ¶
DeactivateNamedusersPath computes a request path to the deactivate action of namedusers.
func DeleteResourcePath ¶
DeleteResourcePath computes a request path to the delete action of resource.
func DeleteSpacePath ¶
DeleteSpacePath computes a request path to the delete action of space.
func DeleteTokenPath ¶
func DeleteTokenPath() string
DeleteTokenPath computes a request path to the Delete action of token.
func DeprovisionNamedusersPath ¶
DeprovisionNamedusersPath computes a request path to the deprovision action of namedusers.
func ExchangeTokenPath ¶
func ExchangeTokenPath() string
ExchangeTokenPath computes a request path to the Exchange action of token.
func HasScopeResourceRolesPath ¶
HasScopeResourceRolesPath computes a request path to the hasScope action of resource_roles.
func KeysTokenPath ¶
func KeysTokenPath() string
KeysTokenPath computes a request path to the keys action of token.
func LinkCallbackTokenPath ¶
func LinkCallbackTokenPath() string
LinkCallbackTokenPath computes a request path to the LinkCallback action of token.
func LinkTokenPath ¶
func LinkTokenPath() string
LinkTokenPath computes a request path to the link action of token.
func ListAssignedByRoleNameResourceRolesPath ¶
ListAssignedByRoleNameResourceRolesPath computes a request path to the listAssignedByRoleName action of resource_roles.
func ListAssignedResourceRolesPath ¶
ListAssignedResourceRolesPath computes a request path to the listAssigned action of resource_roles.
func ListCollaboratorsPath ¶
ListCollaboratorsPath computes a request path to the list action of collaborators.
func ListOrganizationPath ¶
func ListOrganizationPath() string
ListOrganizationPath computes a request path to the list action of organization.
func ListResourcesUserPath ¶
func ListResourcesUserPath() string
ListResourcesUserPath computes a request path to the listResources action of user.
func ListRolesPath ¶
func ListRolesPath() string
ListRolesPath computes a request path to the list action of roles.
func ListTeamPath ¶
func ListTeamPath() string
ListTeamPath computes a request path to the list action of team.
func ListTeamsSpacePath ¶
ListTeamsSpacePath computes a request path to the listTeams action of space.
func ListTokensUsersPath ¶
ListTokensUsersPath computes a request path to the listTokens action of users.
func ListUsersPath ¶
func ListUsersPath() string
ListUsersPath computes a request path to the list action of users.
func LoginLoginPath ¶
func LoginLoginPath() string
LoginLoginPath computes a request path to the login action of login.
func LogoutLogoutPath ¶
func LogoutLogoutPath() string
LogoutLogoutPath computes a request path to the logout action of logout.
func Logoutv2LogoutPath ¶
func Logoutv2LogoutPath() string
Logoutv2LogoutPath computes a request path to the logoutv2 action of logout.
func RefreshTokenPath ¶
func RefreshTokenPath() string
RefreshTokenPath computes a request path to the refresh action of token.
func RegisterResourcePath ¶
func RegisterResourcePath() string
RegisterResourcePath computes a request path to the register action of resource.
func RemoveCollaboratorsPath ¶
RemoveCollaboratorsPath computes a request path to the remove action of collaborators.
func RemoveManyCollaboratorsPath ¶
RemoveManyCollaboratorsPath computes a request path to the remove-many action of collaborators.
func RescindInviteInvitationPath ¶
RescindInviteInvitationPath computes a request path to the rescindInvite action of invitation.
func RetrieveTokenPath ¶
func RetrieveTokenPath() string
RetrieveTokenPath computes a request path to the Retrieve action of token.
func RevokeAllTokensUsersPath ¶
RevokeAllTokensUsersPath computes a request path to the RevokeAllTokens action of users.
func ScopesResourcePath ¶
ScopesResourcePath computes a request path to the scopes action of resource.
func SendEmailVerificationCodeUsersPath ¶
func SendEmailVerificationCodeUsersPath() string
SendEmailVerificationCodeUsersPath computes a request path to the sendEmailVerificationCode action of users.
func ShowClustersPath ¶
func ShowClustersPath() string
ShowClustersPath computes a request path to the show action of clusters.
func ShowOpenidConfigurationPath ¶
func ShowOpenidConfigurationPath() string
ShowOpenidConfigurationPath computes a request path to the show action of openid_configuration.
func ShowResourcePath ¶
ShowResourcePath computes a request path to the show action of resource.
func ShowStatusPath ¶
func ShowStatusPath() string
ShowStatusPath computes a request path to the show action of status.
func ShowUserPath ¶
func ShowUserPath() string
ShowUserPath computes a request path to the show action of user.
func ShowUserinfoPath ¶
func ShowUserinfoPath() string
ShowUserinfoPath computes a request path to the show action of userinfo.
func ShowUsersPath ¶
ShowUsersPath computes a request path to the show action of users.
func StatusTokenPath ¶
func StatusTokenPath() string
StatusTokenPath computes a request path to the Status action of token.
func UpdateUsersPath ¶
func UpdateUsersPath() string
UpdateUsersPath computes a request path to the update action of users.
func UsersSearchPath ¶
func UsersSearchPath() string
UsersSearchPath computes a request path to the users action of search.
func VerifyEmailUsersPath ¶
func VerifyEmailUsersPath() string
VerifyEmailUsersPath computes a request path to the verifyEmail action of users.
Types ¶
type AddManyCollaboratorsPayload ¶
type AddManyCollaboratorsPayload struct { Data []*UpdateUserID `form:"data" json:"data" xml:"data"` // An array of mixed types Included []interface{} `form:"included,omitempty" json:"included,omitempty" xml:"included,omitempty"` }
AddManyCollaboratorsPayload is the collaborators add-many action payload.
type AssignRoleArray ¶
type AssignRoleArray struct {
Data []*AssignRoleData `form:"data" json:"data" xml:"data"`
}
Role Assignment Array (default view)
Identifier: application/vnd.assign-role-array+json; view=default
func (*AssignRoleArray) Validate ¶
func (mt *AssignRoleArray) Validate() (err error)
Validate validates the AssignRoleArray media type instance.
type AssignRoleData ¶
type AssignRoleData struct { // identity ids to assign role to Ids []string `form:"ids" json:"ids" xml:"ids"` // name of the role to assign Role string `form:"role" json:"role" xml:"role"` }
AssignRoleData user type.
func (*AssignRoleData) Validate ¶
func (ut *AssignRoleData) Validate() (err error)
Validate validates the AssignRoleData type instance.
type AssignRoleResourceRolesPayload ¶
type AssignRoleResourceRolesPayload struct {
Data []*AssignRoleData `form:"data" json:"data" xml:"data"`
}
AssignRoleResourceRolesPayload is the resource_roles assignRole action payload.
type AuthToken ¶
type AuthToken struct {
Token *TokenData `form:"token" json:"token" xml:"token"`
}
JWT Token (default view)
Identifier: application/vnd.authtoken+json; view=default
type Client ¶
type Client struct { *goaclient.Client JWTSigner goaclient.Signer Encoder *goa.HTTPEncoder Decoder *goa.HTTPDecoder }
Client is the auth service client.
func (*Client) AcceptInviteInvitation ¶
AcceptInviteInvitation makes a request to the acceptInvite action endpoint of the invitation resource
func (*Client) AddCollaborators ¶
Add a user to the list of space collaborators.
func (*Client) AddManyCollaborators ¶
func (c *Client) AddManyCollaborators(ctx context.Context, path string, payload *AddManyCollaboratorsPayload, contentType string) (*http.Response, error)
Add users to the list of space collaborators.
func (*Client) AssignRoleResourceRoles ¶
func (c *Client) AssignRoleResourceRoles(ctx context.Context, path string, payload *AssignRoleResourceRolesPayload, contentType string) (*http.Response, error)
Assigns roles to one or more identities, for a specific resource
func (*Client) AuditToken ¶
func (c *Client) AuditToken(ctx context.Context, path string, resourceID string) (*http.Response, error)
Verifies the state of an existing token in respect to its privileges for a specified resource, and issues a new token if required
func (*Client) AuthorizeAuthorize ¶
func (c *Client) AuthorizeAuthorize(ctx context.Context, path string, clientID string, redirectURI string, responseType string, state string, apiClient *string, responseMode *string, scope *string) (*http.Response, error)
Authorize service client
func (*Client) BanNamedusers ¶
ban the user
func (*Client) CallbackAuthorize ¶
func (c *Client) CallbackAuthorize(ctx context.Context, path string, code string, state string) (*http.Response, error)
Authorize service client callback
func (*Client) CallbackLogin ¶
func (c *Client) CallbackLogin(ctx context.Context, path string, code *string, state *string) (*http.Response, error)
Authorization code callback
func (*Client) CreateInviteInvitation ¶
func (c *Client) CreateInviteInvitation(ctx context.Context, path string, payload *CreateInviteInvitationPayload, contentType string) (*http.Response, error)
Create a new invitation for a user to join an organization, team or security group, or accept a role for a resource
func (*Client) CreateOrganization ¶
func (c *Client) CreateOrganization(ctx context.Context, path string, payload *CreateOrganizationPayload, contentType string) (*http.Response, error)
Create a new organization
func (*Client) CreateSpace ¶
Create a space resource for the giving space
func (*Client) CreateTeam ¶
func (c *Client) CreateTeam(ctx context.Context, path string, payload *CreateTeamPayload, contentType string) (*http.Response, error)
Create a new team
func (*Client) CreateUsers ¶
func (c *Client) CreateUsers(ctx context.Context, path string, payload *CreateUsersPayload, contentType string) (*http.Response, error)
create a user using a service account
func (*Client) DeactivateNamedusers ¶
deactivate the user
func (*Client) DecodeAssignRoleArray ¶
func (c *Client) DecodeAssignRoleArray(resp *http.Response) (*AssignRoleArray, error)
DecodeAssignRoleArray decodes the AssignRoleArray instance encoded in resp body.
func (*Client) DecodeAuthToken ¶
DecodeAuthToken decodes the AuthToken instance encoded in resp body.
func (*Client) DecodeClusterList ¶
func (c *Client) DecodeClusterList(resp *http.Response) (*ClusterList, error)
DecodeClusterList decodes the ClusterList instance encoded in resp body.
func (*Client) DecodeCreateInvitationRequest ¶
func (c *Client) DecodeCreateInvitationRequest(resp *http.Response) (*CreateInvitationRequest, error)
DecodeCreateInvitationRequest decodes the CreateInvitationRequest instance encoded in resp body.
func (*Client) DecodeCreateOrganizationRequest ¶
func (c *Client) DecodeCreateOrganizationRequest(resp *http.Response) (*CreateOrganizationRequest, error)
DecodeCreateOrganizationRequest decodes the CreateOrganizationRequest instance encoded in resp body.
func (*Client) DecodeCreateOrganizationResponse ¶
func (c *Client) DecodeCreateOrganizationResponse(resp *http.Response) (*CreateOrganizationResponse, error)
DecodeCreateOrganizationResponse decodes the CreateOrganizationResponse instance encoded in resp body.
func (*Client) DecodeCreateTeamRequest ¶
func (c *Client) DecodeCreateTeamRequest(resp *http.Response) (*CreateTeamRequest, error)
DecodeCreateTeamRequest decodes the CreateTeamRequest instance encoded in resp body.
func (*Client) DecodeCreateTeamResponse ¶
func (c *Client) DecodeCreateTeamResponse(resp *http.Response) (*CreateTeamResponse, error)
DecodeCreateTeamResponse decodes the CreateTeamResponse instance encoded in resp body.
func (*Client) DecodeCreateUser ¶
func (c *Client) DecodeCreateUser(resp *http.Response) (*CreateUser, error)
DecodeCreateUser decodes the CreateUser instance encoded in resp body.
func (*Client) DecodeExternalToken ¶
func (c *Client) DecodeExternalToken(resp *http.Response) (*ExternalToken, error)
DecodeExternalToken decodes the ExternalToken instance encoded in resp body.
func (*Client) DecodeExternalTokenStatus ¶
func (c *Client) DecodeExternalTokenStatus(resp *http.Response) (*ExternalTokenStatus, error)
DecodeExternalTokenStatus decodes the ExternalTokenStatus instance encoded in resp body.
func (*Client) DecodeIdentityResourceScope ¶
func (c *Client) DecodeIdentityResourceScope(resp *http.Response) (*IdentityResourceScope, error)
DecodeIdentityResourceScope decodes the IdentityResourceScope instance encoded in resp body.
func (*Client) DecodeIdentityTeamArray ¶
func (c *Client) DecodeIdentityTeamArray(resp *http.Response) (*IdentityTeamArray, error)
DecodeIdentityTeamArray decodes the IdentityTeamArray instance encoded in resp body.
func (*Client) DecodeIdentityroles ¶
func (c *Client) DecodeIdentityroles(resp *http.Response) (*Identityroles, error)
DecodeIdentityroles decodes the Identityroles instance encoded in resp body.
func (*Client) DecodeJSONAPIErrors ¶
func (c *Client) DecodeJSONAPIErrors(resp *http.Response) (*JSONAPIErrors, error)
DecodeJSONAPIErrors decodes the JSONAPIErrors instance encoded in resp body.
func (*Client) DecodeOauthToken ¶
func (c *Client) DecodeOauthToken(resp *http.Response) (*OauthToken, error)
DecodeOauthToken decodes the OauthToken instance encoded in resp body.
func (*Client) DecodeOpenIDConfiguration ¶
func (c *Client) DecodeOpenIDConfiguration(resp *http.Response) (*OpenIDConfiguration, error)
DecodeOpenIDConfiguration decodes the OpenIDConfiguration instance encoded in resp body.
func (*Client) DecodeOrganizationArray ¶
func (c *Client) DecodeOrganizationArray(resp *http.Response) (*OrganizationArray, error)
DecodeOrganizationArray decodes the OrganizationArray instance encoded in resp body.
func (*Client) DecodePublicKeys ¶
func (c *Client) DecodePublicKeys(resp *http.Response) (*PublicKeys, error)
DecodePublicKeys decodes the PublicKeys instance encoded in resp body.
func (*Client) DecodeRPTToken ¶
DecodeRPTToken decodes the RPTToken instance encoded in resp body.
func (*Client) DecodeRedirectLocation ¶
func (c *Client) DecodeRedirectLocation(resp *http.Response) (*RedirectLocation, error)
DecodeRedirectLocation decodes the RedirectLocation instance encoded in resp body.
func (*Client) DecodeRegisterResource ¶
func (c *Client) DecodeRegisterResource(resp *http.Response) (*RegisterResource, error)
DecodeRegisterResource decodes the RegisterResource instance encoded in resp body.
func (*Client) DecodeRegisterResourceResponse ¶
func (c *Client) DecodeRegisterResourceResponse(resp *http.Response) (*RegisterResourceResponse, error)
DecodeRegisterResourceResponse decodes the RegisterResourceResponse instance encoded in resp body.
func (*Client) DecodeResource ¶
DecodeResource decodes the Resource instance encoded in resp body.
func (*Client) DecodeResourceScopes ¶
func (c *Client) DecodeResourceScopes(resp *http.Response) (*ResourceScopes, error)
DecodeResourceScopes decodes the ResourceScopes instance encoded in resp body.
func (*Client) DecodeResourceScopesData ¶
func (c *Client) DecodeResourceScopesData(resp *http.Response) (*ResourceScopesData, error)
DecodeResourceScopesData decodes the ResourceScopesData instance encoded in resp body.
func (*Client) DecodeRoles ¶
DecodeRoles decodes the Roles instance encoded in resp body.
func (*Client) DecodeSpaceResource ¶
func (c *Client) DecodeSpaceResource(resp *http.Response) (*SpaceResource, error)
DecodeSpaceResource decodes the SpaceResource instance encoded in resp body.
func (*Client) DecodeStatus ¶
DecodeStatus decodes the Status instance encoded in resp body.
func (*Client) DecodeTeamArray ¶
DecodeTeamArray decodes the TeamArray instance encoded in resp body.
func (*Client) DecodeUpdateUser ¶
func (c *Client) DecodeUpdateUser(resp *http.Response) (*UpdateUser, error)
DecodeUpdateUser decodes the UpdateUser instance encoded in resp body.
func (*Client) DecodeUpdateUserIDList ¶
func (c *Client) DecodeUpdateUserIDList(resp *http.Response) (*UpdateUserIDList, error)
DecodeUpdateUserIDList decodes the UpdateUserIDList instance encoded in resp body.
func (*Client) DecodeUser ¶
DecodeUser decodes the User instance encoded in resp body.
func (*Client) DecodeUserArray ¶
DecodeUserArray decodes the UserArray instance encoded in resp body.
func (*Client) DecodeUserInfo ¶
DecodeUserInfo decodes the UserInfo instance encoded in resp body.
func (*Client) DecodeUserList ¶
DecodeUserList decodes the UserList instance encoded in resp body.
func (*Client) DecodeUserResourcesList ¶
func (c *Client) DecodeUserResourcesList(resp *http.Response) (*UserResourcesList, error)
DecodeUserResourcesList decodes the UserResourcesList instance encoded in resp body.
func (*Client) DecodeUserTokenArray ¶
func (c *Client) DecodeUserTokenArray(resp *http.Response) (*UserTokenArray, error)
DecodeUserTokenArray decodes the UserTokenArray instance encoded in resp body.
func (*Client) DeleteResource ¶
Delete a resource
func (*Client) DeleteSpace ¶
Delete a space resource for the given space ID
func (*Client) DeleteToken ¶
Delete the external token for resources belonging to external providers like Github and OpenShift
func (*Client) DeprovisionNamedusers ¶
deprovision the user
func (*Client) ExchangeToken ¶
func (c *Client) ExchangeToken(ctx context.Context, path string, payload *TokenExchange, contentType string) (*http.Response, error)
Obtain a security token
func (*Client) HasScopeResourceRoles ¶
Checks if the user has the given scope on the requested resource
func (*Client) KeysToken ¶
func (c *Client) KeysToken(ctx context.Context, path string, format *string) (*http.Response, error)
Returns public keys which should be used to verify tokens
func (*Client) LinkCallbackToken ¶
func (c *Client) LinkCallbackToken(ctx context.Context, path string, code string, state string) (*http.Response, error)
Callback from an external oauth2 resource provider such as GitHub as part of user's account linking
func (*Client) LinkToken ¶
func (c *Client) LinkToken(ctx context.Context, path string, for_ string, redirect *string) (*http.Response, error)
Get a redirect location which should be used to initiate account linking between the user account and an external resource provider such as GitHub
func (*Client) ListAssignedByRoleNameResourceRoles ¶
func (c *Client) ListAssignedByRoleNameResourceRoles(ctx context.Context, path string) (*http.Response, error)
List assigned roles for a specific role name, for a specific resource
func (*Client) ListAssignedResourceRoles ¶
func (c *Client) ListAssignedResourceRoles(ctx context.Context, path string) (*http.Response, error)
List assigned roles by resource
func (*Client) ListCollaborators ¶
func (c *Client) ListCollaborators(ctx context.Context, path string, pageLimit *int, pageOffset *string, ifModifiedSince *string, ifNoneMatch *string) (*http.Response, error)
List collaborators for the given space ID.
func (*Client) ListOrganization ¶
Lists organizations that the user has access to
func (*Client) ListResourcesUser ¶
func (c *Client) ListResourcesUser(ctx context.Context, path string, type_ string) (*http.Response, error)
List resources of a given type with a role for the current user
func (*Client) ListRoles ¶
func (c *Client) ListRoles(ctx context.Context, path string, resourceType *string) (*http.Response, error)
List available roles by resource type
func (*Client) ListTeamsSpace ¶
Lists teams for the specified space
func (*Client) ListTokensUsers ¶
List all tokens for a specified user
func (*Client) ListUsers ¶
func (c *Client) ListUsers(ctx context.Context, path string, filterEmail *string, filterUsername *string, ifModifiedSince *string, ifNoneMatch *string) (*http.Response, error)
List all users.
func (*Client) LoginLogin ¶
func (c *Client) LoginLogin(ctx context.Context, path string, apiClient *string, redirect *string, scope *string) (*http.Response, error)
Login user
func (*Client) LogoutLogout ¶
func (c *Client) LogoutLogout(ctx context.Context, path string, redirect *string, referer *string) (*http.Response, error)
Logout user
func (*Client) Logoutv2Logout ¶
func (c *Client) Logoutv2Logout(ctx context.Context, path string, redirect *string, referer *string) (*http.Response, error)
Logout user
func (*Client) NewAcceptInviteInvitationRequest ¶
func (c *Client) NewAcceptInviteInvitationRequest(ctx context.Context, path string) (*http.Request, error)
NewAcceptInviteInvitationRequest create the request corresponding to the acceptInvite action endpoint of the invitation resource.
func (*Client) NewAddCollaboratorsRequest ¶
func (c *Client) NewAddCollaboratorsRequest(ctx context.Context, path string) (*http.Request, error)
NewAddCollaboratorsRequest create the request corresponding to the add action endpoint of the collaborators resource.
func (*Client) NewAddManyCollaboratorsRequest ¶
func (c *Client) NewAddManyCollaboratorsRequest(ctx context.Context, path string, payload *AddManyCollaboratorsPayload, contentType string) (*http.Request, error)
NewAddManyCollaboratorsRequest create the request corresponding to the add-many action endpoint of the collaborators resource.
func (*Client) NewAssignRoleResourceRolesRequest ¶
func (c *Client) NewAssignRoleResourceRolesRequest(ctx context.Context, path string, payload *AssignRoleResourceRolesPayload, contentType string) (*http.Request, error)
NewAssignRoleResourceRolesRequest create the request corresponding to the assignRole action endpoint of the resource_roles resource.
func (*Client) NewAuditTokenRequest ¶
func (c *Client) NewAuditTokenRequest(ctx context.Context, path string, resourceID string) (*http.Request, error)
NewAuditTokenRequest create the request corresponding to the audit action endpoint of the token resource.
func (*Client) NewAuthorizeAuthorizeRequest ¶
func (c *Client) NewAuthorizeAuthorizeRequest(ctx context.Context, path string, clientID string, redirectURI string, responseType string, state string, apiClient *string, responseMode *string, scope *string) (*http.Request, error)
NewAuthorizeAuthorizeRequest create the request corresponding to the authorize action endpoint of the authorize resource.
func (*Client) NewBanNamedusersRequest ¶
NewBanNamedusersRequest create the request corresponding to the ban action endpoint of the namedusers resource.
func (*Client) NewCallbackAuthorizeRequest ¶
func (c *Client) NewCallbackAuthorizeRequest(ctx context.Context, path string, code string, state string) (*http.Request, error)
NewCallbackAuthorizeRequest create the request corresponding to the callback action endpoint of the authorize resource.
func (*Client) NewCallbackLoginRequest ¶
func (c *Client) NewCallbackLoginRequest(ctx context.Context, path string, code *string, state *string) (*http.Request, error)
NewCallbackLoginRequest create the request corresponding to the callback action endpoint of the login resource.
func (*Client) NewCreateInviteInvitationRequest ¶
func (c *Client) NewCreateInviteInvitationRequest(ctx context.Context, path string, payload *CreateInviteInvitationPayload, contentType string) (*http.Request, error)
NewCreateInviteInvitationRequest create the request corresponding to the createInvite action endpoint of the invitation resource.
func (*Client) NewCreateOrganizationRequest ¶
func (c *Client) NewCreateOrganizationRequest(ctx context.Context, path string, payload *CreateOrganizationPayload, contentType string) (*http.Request, error)
NewCreateOrganizationRequest create the request corresponding to the create action endpoint of the organization resource.
func (*Client) NewCreateSpaceRequest ¶
NewCreateSpaceRequest create the request corresponding to the create action endpoint of the space resource.
func (*Client) NewCreateTeamRequest ¶
func (c *Client) NewCreateTeamRequest(ctx context.Context, path string, payload *CreateTeamPayload, contentType string) (*http.Request, error)
NewCreateTeamRequest create the request corresponding to the create action endpoint of the team resource.
func (*Client) NewCreateUsersRequest ¶
func (c *Client) NewCreateUsersRequest(ctx context.Context, path string, payload *CreateUsersPayload, contentType string) (*http.Request, error)
NewCreateUsersRequest create the request corresponding to the create action endpoint of the users resource.
func (*Client) NewDeactivateNamedusersRequest ¶
func (c *Client) NewDeactivateNamedusersRequest(ctx context.Context, path string) (*http.Request, error)
NewDeactivateNamedusersRequest create the request corresponding to the deactivate action endpoint of the namedusers resource.
func (*Client) NewDeleteResourceRequest ¶
NewDeleteResourceRequest create the request corresponding to the delete action endpoint of the resource resource.
func (*Client) NewDeleteSpaceRequest ¶
NewDeleteSpaceRequest create the request corresponding to the delete action endpoint of the space resource.
func (*Client) NewDeleteTokenRequest ¶
func (c *Client) NewDeleteTokenRequest(ctx context.Context, path string, for_ string) (*http.Request, error)
NewDeleteTokenRequest create the request corresponding to the Delete action endpoint of the token resource.
func (*Client) NewDeprovisionNamedusersRequest ¶
func (c *Client) NewDeprovisionNamedusersRequest(ctx context.Context, path string) (*http.Request, error)
NewDeprovisionNamedusersRequest create the request corresponding to the deprovision action endpoint of the namedusers resource.
func (*Client) NewExchangeTokenRequest ¶
func (c *Client) NewExchangeTokenRequest(ctx context.Context, path string, payload *TokenExchange, contentType string) (*http.Request, error)
NewExchangeTokenRequest create the request corresponding to the Exchange action endpoint of the token resource.
func (*Client) NewHasScopeResourceRolesRequest ¶
func (c *Client) NewHasScopeResourceRolesRequest(ctx context.Context, path string) (*http.Request, error)
NewHasScopeResourceRolesRequest create the request corresponding to the hasScope action endpoint of the resource_roles resource.
func (*Client) NewKeysTokenRequest ¶
func (c *Client) NewKeysTokenRequest(ctx context.Context, path string, format *string) (*http.Request, error)
NewKeysTokenRequest create the request corresponding to the keys action endpoint of the token resource.
func (*Client) NewLinkCallbackTokenRequest ¶
func (c *Client) NewLinkCallbackTokenRequest(ctx context.Context, path string, code string, state string) (*http.Request, error)
NewLinkCallbackTokenRequest create the request corresponding to the LinkCallback action endpoint of the token resource.
func (*Client) NewLinkTokenRequest ¶
func (c *Client) NewLinkTokenRequest(ctx context.Context, path string, for_ string, redirect *string) (*http.Request, error)
NewLinkTokenRequest create the request corresponding to the link action endpoint of the token resource.
func (*Client) NewListAssignedByRoleNameResourceRolesRequest ¶
func (c *Client) NewListAssignedByRoleNameResourceRolesRequest(ctx context.Context, path string) (*http.Request, error)
NewListAssignedByRoleNameResourceRolesRequest create the request corresponding to the listAssignedByRoleName action endpoint of the resource_roles resource.
func (*Client) NewListAssignedResourceRolesRequest ¶
func (c *Client) NewListAssignedResourceRolesRequest(ctx context.Context, path string) (*http.Request, error)
NewListAssignedResourceRolesRequest create the request corresponding to the listAssigned action endpoint of the resource_roles resource.
func (*Client) NewListCollaboratorsRequest ¶
func (c *Client) NewListCollaboratorsRequest(ctx context.Context, path string, pageLimit *int, pageOffset *string, ifModifiedSince *string, ifNoneMatch *string) (*http.Request, error)
NewListCollaboratorsRequest create the request corresponding to the list action endpoint of the collaborators resource.
func (*Client) NewListOrganizationRequest ¶
func (c *Client) NewListOrganizationRequest(ctx context.Context, path string) (*http.Request, error)
NewListOrganizationRequest create the request corresponding to the list action endpoint of the organization resource.
func (*Client) NewListResourcesUserRequest ¶
func (c *Client) NewListResourcesUserRequest(ctx context.Context, path string, type_ string) (*http.Request, error)
NewListResourcesUserRequest create the request corresponding to the listResources action endpoint of the user resource.
func (*Client) NewListRolesRequest ¶
func (c *Client) NewListRolesRequest(ctx context.Context, path string, resourceType *string) (*http.Request, error)
NewListRolesRequest create the request corresponding to the list action endpoint of the roles resource.
func (*Client) NewListTeamRequest ¶
NewListTeamRequest create the request corresponding to the list action endpoint of the team resource.
func (*Client) NewListTeamsSpaceRequest ¶
NewListTeamsSpaceRequest create the request corresponding to the listTeams action endpoint of the space resource.
func (*Client) NewListTokensUsersRequest ¶
NewListTokensUsersRequest create the request corresponding to the listTokens action endpoint of the users resource.
func (*Client) NewListUsersRequest ¶
func (c *Client) NewListUsersRequest(ctx context.Context, path string, filterEmail *string, filterUsername *string, ifModifiedSince *string, ifNoneMatch *string) (*http.Request, error)
NewListUsersRequest create the request corresponding to the list action endpoint of the users resource.
func (*Client) NewLoginLoginRequest ¶
func (c *Client) NewLoginLoginRequest(ctx context.Context, path string, apiClient *string, redirect *string, scope *string) (*http.Request, error)
NewLoginLoginRequest create the request corresponding to the login action endpoint of the login resource.
func (*Client) NewLogoutLogoutRequest ¶
func (c *Client) NewLogoutLogoutRequest(ctx context.Context, path string, redirect *string, referer *string) (*http.Request, error)
NewLogoutLogoutRequest create the request corresponding to the logout action endpoint of the logout resource.
func (*Client) NewLogoutv2LogoutRequest ¶
func (c *Client) NewLogoutv2LogoutRequest(ctx context.Context, path string, redirect *string, referer *string) (*http.Request, error)
NewLogoutv2LogoutRequest create the request corresponding to the logoutv2 action endpoint of the logout resource.
func (*Client) NewRefreshTokenRequest ¶
func (c *Client) NewRefreshTokenRequest(ctx context.Context, path string, payload *RefreshToken, contentType string) (*http.Request, error)
NewRefreshTokenRequest create the request corresponding to the refresh action endpoint of the token resource.
func (*Client) NewRegisterResourceRequest ¶
func (c *Client) NewRegisterResourceRequest(ctx context.Context, path string, payload *RegisterResourcePayload, contentType string) (*http.Request, error)
NewRegisterResourceRequest create the request corresponding to the register action endpoint of the resource resource.
func (*Client) NewRemoveCollaboratorsRequest ¶
func (c *Client) NewRemoveCollaboratorsRequest(ctx context.Context, path string) (*http.Request, error)
NewRemoveCollaboratorsRequest create the request corresponding to the remove action endpoint of the collaborators resource.
func (*Client) NewRemoveManyCollaboratorsRequest ¶
func (c *Client) NewRemoveManyCollaboratorsRequest(ctx context.Context, path string, payload *RemoveManyCollaboratorsPayload, contentType string) (*http.Request, error)
NewRemoveManyCollaboratorsRequest create the request corresponding to the remove-many action endpoint of the collaborators resource.
func (*Client) NewRescindInviteInvitationRequest ¶
func (c *Client) NewRescindInviteInvitationRequest(ctx context.Context, path string) (*http.Request, error)
NewRescindInviteInvitationRequest create the request corresponding to the rescindInvite action endpoint of the invitation resource.
func (*Client) NewRetrieveTokenRequest ¶
func (c *Client) NewRetrieveTokenRequest(ctx context.Context, path string, for_ string, forcePull *bool) (*http.Request, error)
NewRetrieveTokenRequest create the request corresponding to the Retrieve action endpoint of the token resource.
func (*Client) NewRevokeAllTokensUsersRequest ¶
func (c *Client) NewRevokeAllTokensUsersRequest(ctx context.Context, path string) (*http.Request, error)
NewRevokeAllTokensUsersRequest create the request corresponding to the RevokeAllTokens action endpoint of the users resource.
func (*Client) NewScopesResourceRequest ¶
NewScopesResourceRequest create the request corresponding to the scopes action endpoint of the resource resource.
func (*Client) NewSendEmailVerificationCodeUsersRequest ¶
func (c *Client) NewSendEmailVerificationCodeUsersRequest(ctx context.Context, path string) (*http.Request, error)
NewSendEmailVerificationCodeUsersRequest create the request corresponding to the sendEmailVerificationCode action endpoint of the users resource.
func (*Client) NewShowClustersRequest ¶
NewShowClustersRequest create the request corresponding to the show action endpoint of the clusters resource.
func (*Client) NewShowOpenidConfigurationRequest ¶
func (c *Client) NewShowOpenidConfigurationRequest(ctx context.Context, path string) (*http.Request, error)
NewShowOpenidConfigurationRequest create the request corresponding to the show action endpoint of the openid_configuration resource.
func (*Client) NewShowResourceRequest ¶
NewShowResourceRequest create the request corresponding to the show action endpoint of the resource resource.
func (*Client) NewShowStatusRequest ¶
NewShowStatusRequest create the request corresponding to the show action endpoint of the status resource.
func (*Client) NewShowUserRequest ¶
func (c *Client) NewShowUserRequest(ctx context.Context, path string, ifModifiedSince *string, ifNoneMatch *string) (*http.Request, error)
NewShowUserRequest create the request corresponding to the show action endpoint of the user resource.
func (*Client) NewShowUserinfoRequest ¶
NewShowUserinfoRequest create the request corresponding to the show action endpoint of the userinfo resource.
func (*Client) NewShowUsersRequest ¶
func (c *Client) NewShowUsersRequest(ctx context.Context, path string, ifModifiedSince *string, ifNoneMatch *string) (*http.Request, error)
NewShowUsersRequest create the request corresponding to the show action endpoint of the users resource.
func (*Client) NewStatusTokenRequest ¶
func (c *Client) NewStatusTokenRequest(ctx context.Context, path string, for_ string, forcePull *bool) (*http.Request, error)
NewStatusTokenRequest create the request corresponding to the Status action endpoint of the token resource.
func (*Client) NewUpdateUsersRequest ¶
func (c *Client) NewUpdateUsersRequest(ctx context.Context, path string, payload *UpdateUsersPayload, contentType string) (*http.Request, error)
NewUpdateUsersRequest create the request corresponding to the update action endpoint of the users resource.
func (*Client) NewUsersSearchRequest ¶
func (c *Client) NewUsersSearchRequest(ctx context.Context, path string, q string, pageLimit *int, pageOffset *string) (*http.Request, error)
NewUsersSearchRequest create the request corresponding to the users action endpoint of the search resource.
func (*Client) NewVerifyEmailUsersRequest ¶
func (c *Client) NewVerifyEmailUsersRequest(ctx context.Context, path string, code string) (*http.Request, error)
NewVerifyEmailUsersRequest create the request corresponding to the verifyEmail action endpoint of the users resource.
func (*Client) RefreshToken ¶
func (c *Client) RefreshToken(ctx context.Context, path string, payload *RefreshToken, contentType string) (*http.Response, error)
Refresh access token
func (*Client) RegisterResource ¶
func (c *Client) RegisterResource(ctx context.Context, path string, payload *RegisterResourcePayload, contentType string) (*http.Response, error)
Register a new resource
func (*Client) RemoveCollaborators ¶
Remove a user from the list of space collaborators.
func (*Client) RemoveManyCollaborators ¶
func (c *Client) RemoveManyCollaborators(ctx context.Context, path string, payload *RemoveManyCollaboratorsPayload, contentType string) (*http.Response, error)
Remove users form the list of space collaborators.
func (*Client) RescindInviteInvitation ¶
RescindInviteInvitation makes a request to the rescindInvite action endpoint of the invitation resource
func (*Client) RetrieveToken ¶
func (c *Client) RetrieveToken(ctx context.Context, path string, for_ string, forcePull *bool) (*http.Response, error)
Get the external token for resources belonging to external providers like Github and OpenShift. If the token is missing or not valid then 401 Unauthorized status with 'WWW-Authenticate: LINK url=<url>, description=<error_description>' header will be returned. For example: 'WWW-Authenticate: LINK url=https://auth.openshift.io/api/token/link?for=https://github.com, description="GitHub token is missing. Link GitHub account"'
func (*Client) RevokeAllTokensUsers ¶
Revokes all tokens for a specified identity id
func (*Client) ScopesResource ¶
List scopes for a resource
func (*Client) SendEmailVerificationCodeUsers ¶
func (c *Client) SendEmailVerificationCodeUsers(ctx context.Context, path string) (*http.Response, error)
Send a verification code to the user's email address
func (*Client) SetJWTSigner ¶
SetJWTSigner sets the request signer for the jwt security scheme.
func (*Client) ShowClusters ¶
Get clusters configuration
func (*Client) ShowOpenidConfiguration ¶
Show Indentity Provider Configuration. It lists all endpoints supported by Auth Service
func (*Client) ShowResource ¶
Shows a specific resource
func (*Client) ShowStatus ¶
Show the status of the current running instance
func (*Client) ShowUser ¶
func (c *Client) ShowUser(ctx context.Context, path string, ifModifiedSince *string, ifNoneMatch *string) (*http.Response, error)
Get the authenticated user in JSON-API format
func (*Client) ShowUserinfo ¶
Get the authenticated user - part of the OAuth/OpenID connect authentication flow
func (*Client) ShowUsers ¶
func (c *Client) ShowUsers(ctx context.Context, path string, ifModifiedSince *string, ifNoneMatch *string) (*http.Response, error)
Retrieve user for the given ID.
func (*Client) StatusToken ¶
func (c *Client) StatusToken(ctx context.Context, path string, for_ string, forcePull *bool) (*http.Response, error)
Check if the external token is available. Returns 200 OK if the token is available and 401 Unauthorized if no token available
func (*Client) UpdateUsers ¶
func (c *Client) UpdateUsers(ctx context.Context, path string, payload *UpdateUsersPayload, contentType string) (*http.Response, error)
update the authenticated user
type ClusterData ¶
type ClusterData struct { // API URL APIURL string `form:"api-url" json:"api-url" xml:"api-url"` // User application domain name in the cluster AppDNS string `form:"app-dns" json:"app-dns" xml:"app-dns"` // Cluster is full if set to 'true' CapacityExhausted bool `form:"capacity-exhausted" json:"capacity-exhausted" xml:"capacity-exhausted"` // Web console URL ConsoleURL string `form:"console-url" json:"console-url" xml:"console-url"` // Logging URL LoggingURL string `form:"logging-url" json:"logging-url" xml:"logging-url"` // Metrics URL MetricsURL string `form:"metrics-url" json:"metrics-url" xml:"metrics-url"` // Cluster name Name string `form:"name" json:"name" xml:"name"` }
ClusterData user type.
func (*ClusterData) Validate ¶
func (ut *ClusterData) Validate() (err error)
Validate validates the ClusterData type instance.
type ClusterList ¶
type ClusterList struct { Data []*ClusterData `form:"data" json:"data" xml:"data"` // An array of mixed types Included []interface{} `form:"included,omitempty" json:"included,omitempty" xml:"included,omitempty"` }
Holds the response to a cluster list request (default view)
Identifier: application/vnd.clusterlist+json; view=default
func (*ClusterList) Validate ¶
func (mt *ClusterList) Validate() (err error)
Validate validates the ClusterList media type instance.
type CreateIdentityDataAttributes ¶
type CreateIdentityDataAttributes struct { // Whether the user is approved for using an OpenShift cluster. 'True' is used by default Approved *bool `form:"approved,omitempty" json:"approved,omitempty" xml:"approved,omitempty"` // The bio Bio *string `form:"bio,omitempty" json:"bio,omitempty" xml:"bio,omitempty"` // The OpenShift API URL of the cluster where the user is provisioned to Cluster string `form:"cluster" json:"cluster" xml:"cluster"` // The company Company *string `form:"company,omitempty" json:"company,omitempty" xml:"company,omitempty"` // User context information of any type as a json ContextInformation map[string]interface{} `form:"contextInformation,omitempty" json:"contextInformation,omitempty" xml:"contextInformation,omitempty"` // The email Email string `form:"email" json:"email" xml:"email"` // Whether email is verified EmailVerified *bool `form:"emailVerified,omitempty" json:"emailVerified,omitempty" xml:"emailVerified,omitempty"` // Whether the user is enabled Enabled *bool `form:"enabled,omitempty" json:"enabled,omitempty" xml:"enabled,omitempty"` // The level of features that the user wants to use (for unreleased features) FeatureLevel *string `form:"featureLevel,omitempty" json:"featureLevel,omitempty" xml:"featureLevel,omitempty"` // The user's full name FullName *string `form:"fullName,omitempty" json:"fullName,omitempty" xml:"fullName,omitempty"` // The avatar image for the user ImageURL *string `form:"imageURL,omitempty" json:"imageURL,omitempty" xml:"imageURL,omitempty"` // The IDP provided this identity ProviderType *string `form:"providerType,omitempty" json:"providerType,omitempty" xml:"providerType,omitempty"` // Whether the registration has been completed RegistrationCompleted *bool `form:"registrationCompleted,omitempty" json:"registrationCompleted,omitempty" xml:"registrationCompleted,omitempty"` // The Red Hat Developers User ID of the user RhdUserID string `form:"rhd_user_id" json:"rhd_user_id" xml:"rhd_user_id"` // The associated Red Hat Developers account. If not set then username is used as the RHD username RhdUsername *string `form:"rhd_username,omitempty" json:"rhd_username,omitempty" xml:"rhd_username,omitempty"` // The url URL *string `form:"url,omitempty" json:"url,omitempty" xml:"url,omitempty"` // The username Username string `form:"username" json:"username" xml:"username"` }
CreateIdentityDataAttributes user type.
func (*CreateIdentityDataAttributes) Validate ¶
func (ut *CreateIdentityDataAttributes) Validate() (err error)
Validate validates the CreateIdentityDataAttributes type instance.
type CreateInvitationRequest ¶
type CreateInvitationRequest struct { // An array of users invited to become members or to accept a role Data []*Invitee `form:"data" json:"data" xml:"data"` // links to redirect after accepting invitation sucessfully or in case of error Links *RedirectURL `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` }
Request payload required to create new invitations (default view)
Identifier: application/vnd.create_invitation_request+json; view=default
func (*CreateInvitationRequest) Validate ¶
func (mt *CreateInvitationRequest) Validate() (err error)
Validate validates the CreateInvitationRequest media type instance.
type CreateInviteInvitationPayload ¶
type CreateInviteInvitationPayload struct { // An array of users invited to become members or to accept a role Data []*Invitee `form:"data" json:"data" xml:"data"` // links to redirect after accepting invitation sucessfully or in case of error Links *RedirectURL `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` }
CreateInviteInvitationPayload is the invitation createInvite action payload.
type CreateOrganizationPayload ¶
type CreateOrganizationPayload struct { // The name of the new organization Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"` }
CreateOrganizationPayload is the organization create action payload.
type CreateOrganizationRequest ¶
type CreateOrganizationRequest struct { // The name of the new organization Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"` }
Request payload required to create a new organization (default view)
Identifier: application/vnd.create_organization_request+json; view=default
type CreateOrganizationResponse ¶
type CreateOrganizationResponse struct { // The identifier of the new organization OrganizationID *string `form:"organization_id,omitempty" json:"organization_id,omitempty" xml:"organization_id,omitempty"` }
Response returned when creating a new organization (default view)
Identifier: application/vnd.create_organization_response+json; view=default
type CreateTeamPayload ¶
type CreateTeamPayload struct { // The name of the new team Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"` // The identifier of the space in which to create the team SpaceID *string `form:"space_id,omitempty" json:"space_id,omitempty" xml:"space_id,omitempty"` }
CreateTeamPayload is the team create action payload.
type CreateTeamRequest ¶
type CreateTeamRequest struct { // The name of the new team Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"` // The identifier of the space in which to create the team SpaceID *string `form:"space_id,omitempty" json:"space_id,omitempty" xml:"space_id,omitempty"` }
Request payload required to create a new team (default view)
Identifier: application/vnd.create_team_request+json; view=default
type CreateTeamResponse ¶
type CreateTeamResponse struct { // The identifier of the new team TeamID *string `form:"team_id,omitempty" json:"team_id,omitempty" xml:"team_id,omitempty"` }
Response returned when creating a new team (default view)
Identifier: application/vnd.create_team_response+json; view=default
type CreateUser ¶
type CreateUser struct {
Data *CreateUserData `form:"data" json:"data" xml:"data"`
}
User Create (default view)
Identifier: application/vnd.createuser+json; view=default
func (*CreateUser) Validate ¶
func (mt *CreateUser) Validate() (err error)
Validate validates the CreateUser media type instance.
type CreateUserData ¶
type CreateUserData struct { // Attributes of the user identity Attributes *CreateIdentityDataAttributes `form:"attributes" json:"attributes" xml:"attributes"` Links *GenericLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` // type of the user identity Type string `form:"type" json:"type" xml:"type"` }
CreateUserData user type.
func (*CreateUserData) Validate ¶
func (ut *CreateUserData) Validate() (err error)
Validate validates the CreateUserData type instance.
type CreateUsersPayload ¶
type CreateUsersPayload struct {
Data *CreateUserData `form:"data" json:"data" xml:"data"`
}
CreateUsersPayload is the users create action payload.
type ExternalToken ¶
type ExternalToken struct { // The token associated with the identity for the specific external provider AccessToken string `form:"access_token" json:"access_token" xml:"access_token"` // The external provider URL. ProviderAPIURL string `form:"provider_api_url" json:"provider_api_url" xml:"provider_api_url"` // The scope associated with the token Scope string `form:"scope" json:"scope" xml:"scope"` // The type of the toke, example : bearer TokenType string `form:"token_type" json:"token_type" xml:"token_type"` // The username of the identity loaded from the specific external provider Username string `form:"username" json:"username" xml:"username"` }
Tokens from external providers such as GitHub or OpenShift (default view)
Identifier: application/vnd.externaltoken+json; view=default
func (*ExternalToken) Validate ¶
func (mt *ExternalToken) Validate() (err error)
Validate validates the ExternalToken media type instance.
type ExternalTokenStatus ¶
type ExternalTokenStatus struct { // The external provider URL. ProviderAPIURL string `form:"provider_api_url" json:"provider_api_url" xml:"provider_api_url"` // The username of the identity loaded from the specific external provider. Username string `form:"username" json:"username" xml:"username"` }
This endpoint can be used to obtain a status of the available token from external providers such as GitHub or OpenShift (default view)
Identifier: application/vnd.externaltokenstatus+json; view=default
func (*ExternalTokenStatus) Validate ¶
func (mt *ExternalTokenStatus) Validate() (err error)
Validate validates the ExternalTokenStatus media type instance.
type GenericData ¶
type GenericData struct { // UUID of the object ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` Links *GenericLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"` }
GenericData user type.
type GenericLinks ¶
type GenericLinks struct { Meta map[string]interface{} `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"` Related *string `form:"related,omitempty" json:"related,omitempty" xml:"related,omitempty"` Self *string `form:"self,omitempty" json:"self,omitempty" xml:"self,omitempty"` }
GenericLinks user type.
type IdentityResourceScope ¶
type IdentityResourceScope struct {
Data *IdentityResourceScopeData `form:"data" json:"data" xml:"data"`
}
HasScopes for a user on a resource (default view)
Identifier: application/vnd.resource.scopes+json; view=default
func (*IdentityResourceScope) Validate ¶
func (mt *IdentityResourceScope) Validate() (err error)
Validate validates the IdentityResourceScope media type instance.
type IdentityResourceScopeData ¶
type IdentityResourceScopeData struct { // 'true' if the user has the given scope, 'false' otherwise HasScope bool `form:"hasScope" json:"hasScope" xml:"hasScope"` // the name of the scope that was checked ScopeName string `form:"scopeName" json:"scopeName" xml:"scopeName"` }
IdentityResourceScopeData user type.
func (*IdentityResourceScopeData) Validate ¶
func (ut *IdentityResourceScopeData) Validate() (err error)
Validate validates the IdentityResourceScopeData type instance.
type IdentityRolesData ¶
type IdentityRolesData struct { // The ID of the assignee AssigneeID string `form:"assignee_id" json:"assignee_id" xml:"assignee_id"` // The type of assignee, example: user,group,team AssigneeType string `form:"assignee_type" json:"assignee_type" xml:"assignee_type"` Inherited bool `form:"inherited" json:"inherited" xml:"inherited"` // The ID of the resource from this role was inherited InheritedFrom *string `form:"inherited_from,omitempty" json:"inherited_from,omitempty" xml:"inherited_from,omitempty"` // The name of the role RoleName string `form:"role_name" json:"role_name" xml:"role_name"` }
IdentityRolesData user type.
func (*IdentityRolesData) Validate ¶
func (ut *IdentityRolesData) Validate() (err error)
Validate validates the IdentityRolesData type instance.
type IdentityTeamArray ¶
type IdentityTeamArray struct {
Data []*IdentityTeamData `form:"data" json:"data" xml:"data"`
}
Identity Team Array (default view)
Identifier: application/vnd.identity-team-array+json; view=default
func (*IdentityTeamArray) Validate ¶
func (mt *IdentityTeamArray) Validate() (err error)
Validate validates the IdentityTeamArray media type instance.
type IdentityTeamData ¶
type IdentityTeamData struct { // unique id for the team ID string `form:"id" json:"id" xml:"id"` // flag indicating whether the user is a member of the team Member bool `form:"member" json:"member" xml:"member"` // name of the team Name string `form:"name" json:"name" xml:"name"` // roles assigned to the user for the team Roles []string `form:"roles" json:"roles" xml:"roles"` // unique id of the space the team belongs to SpaceID string `form:"space_id" json:"space_id" xml:"space_id"` }
IdentityTeamData user type.
func (*IdentityTeamData) Validate ¶
func (ut *IdentityTeamData) Validate() (err error)
Validate validates the IdentityTeamData type instance.
type Identityroles ¶
type Identityroles struct {
Data []*IdentityRolesData `form:"data" json:"data" xml:"data"`
}
Assigned Roles in a Protected Resource (default view)
Identifier: application/vnd.identityroles+json; view=default
func (*Identityroles) Validate ¶
func (mt *Identityroles) Validate() (err error)
Validate validates the Identityroles media type instance.
type Invitee ¶
type Invitee struct { // unique id for the user identity IdentityID *string `form:"identity-id,omitempty" json:"identity-id,omitempty" xml:"identity-id,omitempty"` // if true invites the user to become a member Member *bool `form:"member,omitempty" json:"member,omitempty" xml:"member,omitempty"` // An array of role names Roles []string `form:"roles,omitempty" json:"roles,omitempty" xml:"roles,omitempty"` }
Invitee user type.
type JSONAPIError ¶
type JSONAPIError struct { // an application-specific error code, expressed as a string value. Code *string `form:"code,omitempty" json:"code,omitempty" xml:"code,omitempty"` // a human-readable explanation specific to this occurrence of the problem. // Like title, this field’s value can be localized. Detail string `form:"detail" json:"detail" xml:"detail"` // a unique identifier for this particular occurrence of the problem. ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` // a links object containing the following members: // * about: a link that leads to further details about this particular occurrence of the problem. Links map[string]*JSONAPILink `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` // a meta object containing non-standard meta-information about the error Meta map[string]interface{} `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"` // an object containing references to the source of the error, // optionally including any of the following members // // * pointer: a JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, // or "/data/attributes/title" for a specific attribute]. // * parameter: a string indicating which URI query parameter caused the error. Source map[string]interface{} `form:"source,omitempty" json:"source,omitempty" xml:"source,omitempty"` // the HTTP status code applicable to this problem, expressed as a string value. Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"` // a short, human-readable summary of the problem that SHOULD NOT // change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `form:"title,omitempty" json:"title,omitempty" xml:"title,omitempty"` }
Error objects provide additional information about problems encountered while performing an operation. Error objects MUST be returned as an array keyed by errors in the top level of a JSON API document.
See. also http://jsonapi.org/format/#error-objects.
func (*JSONAPIError) Validate ¶
func (ut *JSONAPIError) Validate() (err error)
Validate validates the JSONAPIError type instance.
type JSONAPIErrors ¶
type JSONAPIErrors struct {
Errors []*JSONAPIError `form:"errors" json:"errors" xml:"errors"`
}
JSONAPIErrors media type (default view)
Identifier: application/vnd.jsonapierrors+json; view=default
func (*JSONAPIErrors) Validate ¶
func (mt *JSONAPIErrors) Validate() (err error)
Validate validates the JSONAPIErrors media type instance.
type JSONAPILink ¶
type JSONAPILink struct { // a string containing the link's URL. Href *string `form:"href,omitempty" json:"href,omitempty" xml:"href,omitempty"` // a meta object containing non-standard meta-information about the link. Meta map[string]interface{} `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"` }
type OauthToken ¶
type OauthToken struct { // Access token AccessToken *string `form:"access_token,omitempty" json:"access_token,omitempty" xml:"access_token,omitempty"` // Access token expires in seconds ExpiresIn *string `form:"expires_in,omitempty" json:"expires_in,omitempty" xml:"expires_in,omitempty"` // RefreshToken RefreshToken *string `form:"refresh_token,omitempty" json:"refresh_token,omitempty" xml:"refresh_token,omitempty"` // Token type TokenType *string `form:"token_type,omitempty" json:"token_type,omitempty" xml:"token_type,omitempty"` }
Oauth 2.0 token payload (default view)
Identifier: application/vnd.oauthtoken+json; view=default
type OpenIDConfiguration ¶
type OpenIDConfiguration struct { // REQUIRED. URL of the OpenID Provider's OAuth 2.0 Authorization Endpoint AuthorizationEndpoint *string `form:"authorization_endpoint,omitempty" json:"authorization_endpoint,omitempty" xml:"authorization_endpoint,omitempty"` // RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. ClaimsSupported []string `form:"claims_supported,omitempty" json:"claims_supported,omitempty" xml:"claims_supported,omitempty"` // URL of the OpenID Provider's Logout Endpoint EndSessionEndpoint *string `form:"end_session_endpoint,omitempty" json:"end_session_endpoint,omitempty" xml:"end_session_endpoint,omitempty"` // OPTIONAL. JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. Dynamic OpenID Providers MUST support the authorization_code and implicit Grant Type values and MAY support other Grant Types. GrantTypesSupported []string `form:"grant_types_supported,omitempty" json:"grant_types_supported,omitempty" xml:"grant_types_supported,omitempty"` // REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OpenID Provider for the ID Token to encode the Claims in a JWT. The algorithm RS256 MUST be included. IDTokenSigningAlgValuesSupported []string `` /* 163-byte string literal not displayed */ // REQUIRED. URL using the https scheme with no query or fragment component that the OpenID Provider asserts as its Issuer Identifier. If Issuer discovery is supported, this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this Issuer. Issuer *string `form:"issuer,omitempty" json:"issuer,omitempty" xml:"issuer,omitempty"` // REQUIRED. URL of the OpenID Provider's JSON Web Key Set [JWK] document. This contains the signing key(s) the Relying Parties uses to validate signatures from the OpenID Provider. The JWK Set MAY also contain the Server's encryption key(s), which are used by Relying Parties to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. JwksURI *string `form:"jwks_uri,omitempty" json:"jwks_uri,omitempty" xml:"jwks_uri,omitempty"` // REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this OpenID Provider supports. ResponseTypesSupported []string `form:"response_types_supported,omitempty" json:"response_types_supported,omitempty" xml:"response_types_supported,omitempty"` // RECOMMENDED. JSON array containing a list of the OAuth 2.0 scope values that this server supports. The server MUST support the `openid` scope value. ScopesSupported []string `form:"scopes_supported,omitempty" json:"scopes_supported,omitempty" xml:"scopes_supported,omitempty"` // REQUIRED. JSON array containing a list of the Subject Identifier types that this OpenID Provider supports. Valid types include pairwise and public. SubjectTypesSupported []string `form:"subject_types_supported,omitempty" json:"subject_types_supported,omitempty" xml:"subject_types_supported,omitempty"` // URL of the OpenID Provider's OAuth 2.0 Token Endpoint. This is REQUIRED unless only the Implicit Flow is used. TokenEndpoint *string `form:"token_endpoint,omitempty" json:"token_endpoint,omitempty" xml:"token_endpoint,omitempty"` // OPTIONAL. JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt etc. TokenEndpointAuthMethodsSupported []string `` /* 163-byte string literal not displayed */ // RECOMMENDED. URL of the OpenID Provider's UserInfo Endpoint UserinfoEndpoint *string `form:"userinfo_endpoint,omitempty" json:"userinfo_endpoint,omitempty" xml:"userinfo_endpoint,omitempty"` }
Indentity Provider Configuration. It list all endpoints supported by Auth Service (default view)
Identifier: application/vnd.openidconfiguration+json; view=default
type OrganizationArray ¶
type OrganizationArray struct {
Data []*OrganizationData `form:"data" json:"data" xml:"data"`
}
Organization Array (default view)
Identifier: application/vnd.organization-array+json; view=default
func (*OrganizationArray) Validate ¶
func (mt *OrganizationArray) Validate() (err error)
Validate validates the OrganizationArray media type instance.
type OrganizationData ¶
type OrganizationData struct { // unique id for the organization ID string `form:"id" json:"id" xml:"id"` // flag indicating whether the user is a member of the organization Member bool `form:"member" json:"member" xml:"member"` // name of the organization Name string `form:"name" json:"name" xml:"name"` // roles assigned to the user for the organization Roles []string `form:"roles" json:"roles" xml:"roles"` }
OrganizationData user type.
func (*OrganizationData) Validate ¶
func (ut *OrganizationData) Validate() (err error)
Validate validates the OrganizationData type instance.
type PagingLinks ¶
type PagingLinks struct { Filters *string `form:"filters,omitempty" json:"filters,omitempty" xml:"filters,omitempty"` First *string `form:"first,omitempty" json:"first,omitempty" xml:"first,omitempty"` Last *string `form:"last,omitempty" json:"last,omitempty" xml:"last,omitempty"` Next *string `form:"next,omitempty" json:"next,omitempty" xml:"next,omitempty"` Prev *string `form:"prev,omitempty" json:"prev,omitempty" xml:"prev,omitempty"` }
PagingLinks user type.
type PublicKeys ¶
type PublicKeys struct {
Keys []interface{} `form:"keys" json:"keys" xml:"keys"`
}
Public Keys (default view)
Identifier: application/vnd.publickeys+json; view=default
func (*PublicKeys) Validate ¶
func (mt *PublicKeys) Validate() (err error)
Validate validates the PublicKeys media type instance.
type RPTToken ¶
type RPTToken struct { // RPT token RptToken *string `form:"rpt_token,omitempty" json:"rpt_token,omitempty" xml:"rpt_token,omitempty"` }
JWT Token (default view)
Identifier: application/vnd.rpttoken+json; view=default
type RedirectLocation ¶
type RedirectLocation struct { // The location which should be used to redirect browser RedirectLocation string `form:"redirect_location" json:"redirect_location" xml:"redirect_location"` }
Redirect Location (default view)
Identifier: application/vnd.redirectlocation+json; view=default
func (*RedirectLocation) Validate ¶
func (mt *RedirectLocation) Validate() (err error)
Validate validates the RedirectLocation media type instance.
type RedirectURL ¶
type RedirectURL struct { // URL to be redirected to after failed to accept invitation. If not set then will redirect to default url's used in auth config. OnFailure *string `form:"OnFailure,omitempty" json:"OnFailure,omitempty" xml:"OnFailure,omitempty"` // URL to be redirected to after successfully accepting invitation. If not set then will redirect to default url's used in auth config. OnSuccess *string `form:"OnSuccess,omitempty" json:"OnSuccess,omitempty" xml:"OnSuccess,omitempty"` }
RedirectURL user type.
type RefreshToken ¶
type RefreshToken struct { // Refresh token RefreshToken *string `form:"refresh_token,omitempty" json:"refresh_token,omitempty" xml:"refresh_token,omitempty"` }
RefreshToken user type.
type RegisterResource ¶
type RegisterResource struct { // The parent resource (of the same type) to which this resource belongs ParentResourceID *string `form:"parent_resource_id,omitempty" json:"parent_resource_id,omitempty" xml:"parent_resource_id,omitempty"` // The identifier for this resource. If left blank, one will be generated ResourceID *string `form:"resource_id,omitempty" json:"resource_id,omitempty" xml:"resource_id,omitempty"` // The type of resource Type string `form:"type" json:"type" xml:"type"` }
Payload for registering a resource (default view)
Identifier: application/vnd.register_resource+json; view=default
func (*RegisterResource) Validate ¶
func (mt *RegisterResource) Validate() (err error)
Validate validates the RegisterResource media type instance.
type RegisterResourcePayload ¶
type RegisterResourcePayload struct { // The identity who would be provided the scope to manage this resource, If left blank, nobody would be assigned the scope to manage this resource IdentityID *string `form:"identity_id,omitempty" json:"identity_id,omitempty" xml:"identity_id,omitempty"` // The parent resource (of the same type) to which this resource belongs ParentResourceID *string `form:"parent_resource_id,omitempty" json:"parent_resource_id,omitempty" xml:"parent_resource_id,omitempty"` // The identifier for this resource. If left blank, one will be generated ResourceID *string `form:"resource_id,omitempty" json:"resource_id,omitempty" xml:"resource_id,omitempty"` // The type of resource Type string `form:"type" json:"type" xml:"type"` }
RegisterResourcePayload is the resource register action payload.
type RegisterResourceResponse ¶
type RegisterResourceResponse struct { // The identifier for the registered resource ResourceID *string `form:"resource_id,omitempty" json:"resource_id,omitempty" xml:"resource_id,omitempty"` }
Response returned when a resource is registered (default view)
Identifier: application/vnd.register_resource_response+json; view=default
type RelationGeneric ¶
type RelationGeneric struct { Data *GenericData `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"` Links *GenericLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` Meta map[string]interface{} `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"` }
RelationGeneric user type.
type RelationGenericList ¶
type RelationGenericList struct { Data []*GenericData `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"` Links *GenericLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` Meta map[string]interface{} `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"` }
RelationGenericList user type.
type RemoveManyCollaboratorsPayload ¶
type RemoveManyCollaboratorsPayload struct { Data []*UpdateUserID `form:"data" json:"data" xml:"data"` // An array of mixed types Included []interface{} `form:"included,omitempty" json:"included,omitempty" xml:"included,omitempty"` }
RemoveManyCollaboratorsPayload is the collaborators remove-many action payload.
type Resource ¶
type Resource struct { // The parent resource (of the same type) to which this resource belongs ParentResourceID *string `form:"parent_resource_id,omitempty" json:"parent_resource_id,omitempty" xml:"parent_resource_id,omitempty"` // The identifier for this resource. If left blank, one will be generated ResourceID *string `form:"resource_id,omitempty" json:"resource_id,omitempty" xml:"resource_id,omitempty"` // The valid scopes for this resource ResourceScopes []string `form:"resource_scopes,omitempty" json:"resource_scopes,omitempty" xml:"resource_scopes,omitempty"` // The type of resource Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"` }
A Protected Resource (default view)
Identifier: application/vnd.resource+json; view=default
type ResourceScopes ¶
type ResourceScopes struct { // Name of the scope ID string `form:"id" json:"id" xml:"id"` // Type of resource Type string `form:"type" json:"type" xml:"type"` }
Resource scopes payload (default view)
Identifier: application/vnd.resource_scopes+json; view=default
func (*ResourceScopes) Validate ¶
func (mt *ResourceScopes) Validate() (err error)
Validate validates the ResourceScopes media type instance.
type ResourceScopesData ¶
type ResourceScopesData struct { // The data wrapper for the response Data []*ResourceScopes `form:"data" json:"data" xml:"data"` }
Resource scopes data wrapper (default view)
Identifier: application/vnd.resource_scopes_data+json; view=default
func (*ResourceScopesData) Validate ¶
func (mt *ResourceScopesData) Validate() (err error)
Validate validates the ResourceScopesData media type instance.
type Roles ¶
type Roles struct {
Data []*RolesData `form:"data" json:"data" xml:"data"`
}
Available Roles for a Resource Type (default view)
Identifier: application/vnd.roles+json; view=default
type RolesData ¶
type RolesData struct { // The resource type ResourceType string `form:"resource_type" json:"resource_type" xml:"resource_type"` // The name of the role RoleName string `form:"role_name" json:"role_name" xml:"role_name"` // The scopes defined for this role Scope []string `form:"scope" json:"scope" xml:"scope"` }
RolesData user type.
type Space ¶
type Space struct { // ID of the space ID *uuid.UUID `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` }
Space user type.
type SpaceResource ¶
type SpaceResource struct {
Data *SpaceResourceData `form:"data" json:"data" xml:"data"`
}
Space Resource (default view)
Identifier: application/vnd.spaceresource+json; view=default
func (*SpaceResource) Validate ¶
func (mt *SpaceResource) Validate() (err error)
Validate validates the SpaceResource media type instance.
type SpaceResourceData ¶
type SpaceResourceData struct { // Keycloak Resource ID associated with this Space ResourceID string `form:"resourceID" json:"resourceID" xml:"resourceID"` }
SpaceResourceData user type.
func (*SpaceResourceData) Validate ¶
func (ut *SpaceResourceData) Validate() (err error)
Validate validates the SpaceResourceData type instance.
type Status ¶
type Status struct { // The time when built BuildTime string `form:"buildTime" json:"buildTime" xml:"buildTime"` // Commit SHA this build is based on Commit string `form:"commit" json:"commit" xml:"commit"` // The status of the used configuration. 'OK' or an error message if there is something wrong with the configuration used by service. ConfigurationStatus string `form:"configurationStatus" json:"configurationStatus" xml:"configurationStatus"` // The status of Database connection. 'OK' or an error message is displayed. DatabaseStatus string `form:"databaseStatus" json:"databaseStatus" xml:"databaseStatus"` // 'True' if the Developer Mode is enabled DevMode *bool `form:"devMode,omitempty" json:"devMode,omitempty" xml:"devMode,omitempty"` // The time when started StartTime string `form:"startTime" json:"startTime" xml:"startTime"` }
The status of the current running instance (default view)
Identifier: application/vnd.status+json; view=default
type TeamArray ¶
type TeamArray struct {
Data []*TeamData `form:"data" json:"data" xml:"data"`
}
Team Array (default view)
Identifier: application/vnd.team-array+json; view=default
type TeamData ¶
type TeamData struct { // unique id for the team ID string `form:"id" json:"id" xml:"id"` // name of the team Name string `form:"name" json:"name" xml:"name"` }
TeamData user type.
type TokenData ¶
type TokenData struct { // Access token AccessToken *string `form:"access_token,omitempty" json:"access_token,omitempty" xml:"access_token,omitempty"` // Access token expires in seconds ExpiresIn interface{} `form:"expires_in" json:"expires_in" xml:"expires_in"` // Token is not valid if issued before this date NotBeforePolicy interface{} `form:"not-before-policy" json:"not-before-policy" xml:"not-before-policy"` // Refresh token expires in seconds RefreshExpiresIn interface{} `form:"refresh_expires_in" json:"refresh_expires_in" xml:"refresh_expires_in"` // Refresh token RefreshToken *string `form:"refresh_token,omitempty" json:"refresh_token,omitempty" xml:"refresh_token,omitempty"` // Token type TokenType *string `form:"token_type,omitempty" json:"token_type,omitempty" xml:"token_type,omitempty"` }
TokenData user type.
type TokenExchange ¶
type TokenExchange struct { // Service Account ID. Used to obtain a PAT for this service account. ClientID string `form:"client_id" json:"client_id" xml:"client_id"` // Service Account secret. Used to obtain a PAT for this service account. ClientSecret *string `form:"client_secret,omitempty" json:"client_secret,omitempty" xml:"client_secret,omitempty"` // this is the authorization_code you received from /api/authorize endpoint Code *string `form:"code,omitempty" json:"code,omitempty" xml:"code,omitempty"` // Grant type. If set to "client_credentials" then this token exchange request is for a Protection API Token (PAT). PAT can be used to authenticate the corresponding Service Account. If the Grant Type is "authorization_code" we can use a authorization_code to get access_token GrantType string `form:"grant_type" json:"grant_type" xml:"grant_type"` // Must be identical to the redirect URI provided while getting the authorization_code RedirectURI *string `form:"redirect_uri,omitempty" json:"redirect_uri,omitempty" xml:"redirect_uri,omitempty"` // Refresh Token RefreshToken *string `form:"refresh_token,omitempty" json:"refresh_token,omitempty" xml:"refresh_token,omitempty"` }
TokenExchange user type.
func (*TokenExchange) Validate ¶
func (ut *TokenExchange) Validate() (err error)
Validate validates the TokenExchange type instance.
type TokenPrivilegeData ¶
type TokenPrivilegeData struct { // resource identifier ResourceID string `form:"resource_id" json:"resource_id" xml:"resource_id"` // scopes granted for resource Scopes string `form:"scopes" json:"scopes" xml:"scopes"` // flag indicating whether these privileges are stale Stale bool `form:"stale" json:"stale" xml:"stale"` }
TokenPrivilegeData user type.
func (*TokenPrivilegeData) Validate ¶
func (ut *TokenPrivilegeData) Validate() (err error)
Validate validates the TokenPrivilegeData type instance.
type UpdateIdentityDataAttributes ¶
type UpdateIdentityDataAttributes struct { // Whether the identity has been banned Banned *bool `form:"banned,omitempty" json:"banned,omitempty" xml:"banned,omitempty"` // The bio Bio *string `form:"bio,omitempty" json:"bio,omitempty" xml:"bio,omitempty"` // The company Company *string `form:"company,omitempty" json:"company,omitempty" xml:"company,omitempty"` // User context information of any type as a json ContextInformation map[string]interface{} `form:"contextInformation,omitempty" json:"contextInformation,omitempty" xml:"contextInformation,omitempty"` // Whether the identity has been deprovisioned (DEPRECATED: use 'banned' instead) Deprovisioned *bool `form:"deprovisioned,omitempty" json:"deprovisioned,omitempty" xml:"deprovisioned,omitempty"` // The email Email *string `form:"email,omitempty" json:"email,omitempty" xml:"email,omitempty"` // Whether the email address would be private. EmailPrivate *bool `form:"emailPrivate,omitempty" json:"emailPrivate,omitempty" xml:"emailPrivate,omitempty"` // The level of features that the user wants to use (for unreleased features) FeatureLevel *string `form:"featureLevel,omitempty" json:"featureLevel,omitempty" xml:"featureLevel,omitempty"` // The users full name FullName *string `form:"fullName,omitempty" json:"fullName,omitempty" xml:"fullName,omitempty"` // The avatar image for the user ImageURL *string `form:"imageURL,omitempty" json:"imageURL,omitempty" xml:"imageURL,omitempty"` // Complete the registration to proceed. This can only be set to true RegistrationCompleted *bool `form:"registrationCompleted,omitempty" json:"registrationCompleted,omitempty" xml:"registrationCompleted,omitempty"` // The url URL *string `form:"url,omitempty" json:"url,omitempty" xml:"url,omitempty"` // The username Username *string `form:"username,omitempty" json:"username,omitempty" xml:"username,omitempty"` }
UpdateIdentityDataAttributes user type.
type UpdateUser ¶
type UpdateUser struct {
Data *UpdateUserData `form:"data" json:"data" xml:"data"`
}
User Update (default view)
Identifier: application/vnd.updateuser+json; view=default
func (*UpdateUser) Validate ¶
func (mt *UpdateUser) Validate() (err error)
Validate validates the UpdateUser media type instance.
type UpdateUserData ¶
type UpdateUserData struct { // Attributes of the user identity Attributes *UpdateIdentityDataAttributes `form:"attributes" json:"attributes" xml:"attributes"` Links *GenericLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` // type of the user identity Type string `form:"type" json:"type" xml:"type"` }
UpdateUserData user type.
func (*UpdateUserData) Validate ¶
func (ut *UpdateUserData) Validate() (err error)
Validate validates the UpdateUserData type instance.
type UpdateUserID ¶
type UpdateUserID struct { // user identity ID ID string `form:"id" json:"id" xml:"id"` Type string `form:"type" json:"type" xml:"type"` }
JSONAPI store for the data of a user identity ID. See also http://jsonapi.org/format/#document-resource-object
func (*UpdateUserID) Validate ¶
func (ut *UpdateUserID) Validate() (err error)
Validate validates the UpdateUserID type instance.
type UpdateUserIDList ¶
type UpdateUserIDList struct { Data []*UpdateUserID `form:"data" json:"data" xml:"data"` // An array of mixed types Included []interface{} `form:"included,omitempty" json:"included,omitempty" xml:"included,omitempty"` }
Holds the response of user idenitity IDs for updating list of user IDs (default view)
Identifier: application/vnd.updateuseridlist+json; view=default
func (*UpdateUserIDList) Validate ¶
func (mt *UpdateUserIDList) Validate() (err error)
Validate validates the UpdateUserIDList media type instance.
type UpdateUsersPayload ¶
type UpdateUsersPayload struct {
Data *UpdateUserData `form:"data" json:"data" xml:"data"`
}
UpdateUsersPayload is the users update action payload.
type User ¶
type User struct {
Data *UserData `form:"data" json:"data" xml:"data"`
}
User Identity (default view)
Identifier: application/vnd.user+json; view=default
type UserArray ¶
type UserArray struct {
Data []*UserData `form:"data" json:"data" xml:"data"`
}
User Array (default view)
Identifier: application/vnd.user-array+json; view=default
type UserData ¶
type UserData struct { // Attributes of the user Attributes *UserDataAttributes `form:"attributes" json:"attributes" xml:"attributes"` // unique id for the user ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` Links *GenericLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` // type of the user Type string `form:"type" json:"type" xml:"type"` }
UserData user type.
type UserDataAttributes ¶
type UserDataAttributes struct { // The bio Bio *string `form:"bio,omitempty" json:"bio,omitempty" xml:"bio,omitempty"` // The OpenShift API URL of the cluster where the user is provisioned to Cluster *string `form:"cluster,omitempty" json:"cluster,omitempty" xml:"cluster,omitempty"` // The company Company *string `form:"company,omitempty" json:"company,omitempty" xml:"company,omitempty"` // User context information of any type as a json ContextInformation map[string]interface{} `form:"contextInformation,omitempty" json:"contextInformation,omitempty" xml:"contextInformation,omitempty"` // The date of creation of the user CreatedAt *time.Time `form:"created-at,omitempty" json:"created-at,omitempty" xml:"created-at,omitempty"` // The email Email *string `form:"email,omitempty" json:"email,omitempty" xml:"email,omitempty"` // Whether the email address would be private. EmailPrivate *bool `form:"emailPrivate,omitempty" json:"emailPrivate,omitempty" xml:"emailPrivate,omitempty"` // Whether the email is a verified one EmailVerified *bool `form:"emailVerified,omitempty" json:"emailVerified,omitempty" xml:"emailVerified,omitempty"` // The level of features that the user wants to use (for unreleased features) FeatureLevel *string `form:"featureLevel,omitempty" json:"featureLevel,omitempty" xml:"featureLevel,omitempty"` // The user's full name FullName *string `form:"fullName,omitempty" json:"fullName,omitempty" xml:"fullName,omitempty"` // The id of the corresponding Identity IdentityID *string `form:"identityID,omitempty" json:"identityID,omitempty" xml:"identityID,omitempty"` // The avatar image for the user ImageURL *string `form:"imageURL,omitempty" json:"imageURL,omitempty" xml:"imageURL,omitempty"` // The IDP provided this identity ProviderType *string `form:"providerType,omitempty" json:"providerType,omitempty" xml:"providerType,omitempty"` // Whether the registration has been completed RegistrationCompleted *bool `form:"registrationCompleted,omitempty" json:"registrationCompleted,omitempty" xml:"registrationCompleted,omitempty"` // The date of update of the user UpdatedAt *time.Time `form:"updated-at,omitempty" json:"updated-at,omitempty" xml:"updated-at,omitempty"` // The url URL *string `form:"url,omitempty" json:"url,omitempty" xml:"url,omitempty"` // The id of the corresponding User UserID *string `form:"userID,omitempty" json:"userID,omitempty" xml:"userID,omitempty"` // The username Username *string `form:"username,omitempty" json:"username,omitempty" xml:"username,omitempty"` }
UserDataAttributes user type.
type UserInfo ¶
type UserInfo struct { // email of the user Email *string `form:"email,omitempty" json:"email,omitempty" xml:"email,omitempty"` // last name, can be achieved from fullName from the user table FamilyName *string `form:"family_name,omitempty" json:"family_name,omitempty" xml:"family_name,omitempty"` // first name, can be achieved from fullName rrom the user table GivenName *string `form:"given_name,omitempty" json:"given_name,omitempty" xml:"given_name,omitempty"` // username, each identity has a username PreferredUsername *string `form:"preferred_username,omitempty" json:"preferred_username,omitempty" xml:"preferred_username,omitempty"` // subject (identity is subject) Sub *string `form:"sub,omitempty" json:"sub,omitempty" xml:"sub,omitempty"` }
User Information (default view)
Identifier: application/vnd.userinfo+json; view=default
type UserList ¶
type UserList struct { Data []*UserData `form:"data" json:"data" xml:"data"` // An array of mixed types Included []interface{} `form:"included,omitempty" json:"included,omitempty" xml:"included,omitempty"` Links *PagingLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` Meta *UserListMeta `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"` }
Holds the paginated response to a user list request (default view)
Identifier: application/vnd.userlist+json; view=default
type UserListMeta ¶
type UserListMeta struct {
TotalCount int `form:"totalCount" json:"totalCount" xml:"totalCount"`
}
UserListMeta user type.
type UserResourceData ¶
type UserResourceData struct { // id of the resource that in which the user has a role ID string `form:"id" json:"id" xml:"id"` Links *GenericLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` // type of the resource Type string `form:"type" json:"type" xml:"type"` }
UserResourceData user type.
func (*UserResourceData) Validate ¶
func (ut *UserResourceData) Validate() (err error)
Validate validates the UserResourceData type instance.
type UserResourcesList ¶
type UserResourcesList struct { Data []*UserResourceData `form:"data" json:"data" xml:"data"` // An array of mixed types Included []interface{} `form:"included,omitempty" json:"included,omitempty" xml:"included,omitempty"` Links *PagingLinks `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"` Meta *UserListMeta `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"` }
Holds the paginated response to a user spaces request (default view)
Identifier: application/vnd.userresourceslist+json; view=default
func (*UserResourcesList) Validate ¶
func (mt *UserResourcesList) Validate() (err error)
Validate validates the UserResourcesList media type instance.
type UserTokenArray ¶
type UserTokenArray struct {
Data []*UserTokenData `form:"data" json:"data" xml:"data"`
}
User Token Array (default view)
Identifier: application/vnd.user-token-array+json; view=default
func (*UserTokenArray) Validate ¶
func (mt *UserTokenArray) Validate() (err error)
Validate validates the UserTokenArray media type instance.
type UserTokenData ¶
type UserTokenData struct { // token expiry time ExpiryTime time.Time `form:"expiry_time" json:"expiry_time" xml:"expiry_time"` Permissions []*TokenPrivilegeData `form:"permissions,omitempty" json:"permissions,omitempty" xml:"permissions,omitempty"` // token status Status int `form:"status" json:"status" xml:"status"` // unique token identifier TokenID string `form:"token_id" json:"token_id" xml:"token_id"` // token type TokenType string `form:"token_type" json:"token_type" xml:"token_type"` }
UserTokenData user type.
func (*UserTokenData) Validate ¶
func (ut *UserTokenData) Validate() (err error)
Validate validates the UserTokenData type instance.