→
https://api.spectrocloud.com/v1alpha1/users
summary:
Lists usersdescription:
Lists users the given user contextParameters:
Name | Type | Description | Required |
---|---|---|---|
fields | string | Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name | no |
filters | string | Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource. | no |
orderBy | string | Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1 | no |
limit | integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
continue | string | continue token for the dataset | no |
200
OK
OK
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"emailId": "string","firstName": "string","lastName": "string","roles": ["string"]},"status": {"activationLink": "string","isActive": "boolean","lastPasswordUpdate": "date-time","lastSignIn": "date-time"}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/users
summary:
Create Userdescription:
A user is created for the given user context{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"emailId": "string","firstName": "string","lastName": "string","roles": ["string"],"teams": ["string"]}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1alpha1/users/assets/sshkeys
summary:
Returns the specified Users assets ssh keysdescription:
Returns a list of users assets ssh keysParameters:
Name | Type | Description | Required |
---|---|---|---|
limit | integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
continue | string | continue token for the dataset | no |
200
OK
OK
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"publicKey": "string"}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/users/assets/sshkeys
summary:
Stores the specified Users assets ssh{"metadata": {"annotations": "object","labels": "object","name": "string"},"spec": {"publicKey": "string"}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1alpha1/users/assets/sshkeys/{uid}
summary:
Returns the specified Users ssh keyPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
OK
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"publicKey": "string"}}
→
https://api.spectrocloud.com/v1alpha1/users/assets/sshkeys/{uid}
summary:
Updates the specified Users ssh keyPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"publicKey": "string"}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/users/assets/sshkeys/{uid}
summary:
Returns the specified Users ssh keyPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1alpha1/users/assets/vsphere/dnsMapping
summary:
Returns the specified vsphere dns mappingParameters:
Name | Type | Description | Required |
---|---|---|---|
gatewayUid | string | yes | |
datacenter | string | yes | |
network | string | yes |
200
OK
OK
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"datacenter": "string","dnsName": "string","network": "string","networkUrl": "string","privateGatewayUid": "string"}}
→
https://api.spectrocloud.com/v1alpha1/users/assets/vsphere/dnsMappings
summary:
Returns the specified vsphere dns mappingsdescription:
Returns a list of vsphere dns mappingsParameters:
Name | Type | Description | Required |
---|---|---|---|
limit | integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
continue | string | continue token for the dataset | no |
filters | string | Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource. | no |
200
OK
OK
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"datacenter": "string","dnsName": "string","network": "string","networkUrl": "string","privateGatewayUid": "string"}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/users/assets/vsphere/dnsMappings
summary:
Stores the vsphere dns mapping{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"datacenter": "string","dnsName": "string","network": "string","networkUrl": "string","privateGatewayUid": "string"}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1alpha1/users/assets/vsphere/dnsMappings/{uid}
summary:
Returns the specified vsphere dns mappingPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
OK
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"datacenter": "string","dnsName": "string","network": "string","networkUrl": "string","privateGatewayUid": "string"}}
→
https://api.spectrocloud.com/v1alpha1/users/assets/vsphere/dnsMappings/{uid}
summary:
Updates the specified vsphere dns mappingPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"datacenter": "string","dnsName": "string","network": "string","networkUrl": "string","privateGatewayUid": "string"}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/users/assets/vsphere/dnsMappings/{uid}
summary:
Deletes the vsphere dns mappingPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1alpha1/users/me
summary:
Returns the specified User ACL informationdescription:
Returns a User with permissions with scopes 200
OK
OK
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"emailId": "string","firstName": "string","lastName": "string","roles": ["string"]},"status": {"activationLink": "string","isActive": "boolean","isContractAccepted": "boolean","projectPermissions": "object","tenant": {"orgName": "string","tenantUid": "string"},"tenantPermissions": "object"}}
→
https://api.spectrocloud.com/v1alpha1/users/password/change
summary:
User password change request using the user emailIddescription:
User password change request via current password and emailId{"currentPassword": "string","emailId": "string","newPassword": "string"}
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1alpha1/users/password/reset
summary:
User password reset request using the email iddescription:
User password request will be sent to the supplied emailId{"emailId": "string"}
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1alpha1/users/summary
summary:
Returns the specified User Summary listdescription:
Returns a list of user summariesParameters:
Name | Type | Description | Required |
---|---|---|---|
limit | integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
continue | string | continue token for the dataset | no |
200
OK
OK
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"emailId": "string","firstName": "string","lastName": "string","projects": [{"name": "string","uid": "string"}],"roles": [{"name": "string","uid": "string"}],"teams": [{"name": "string","uid": "string"}]},"status": {"activationLink": "string","isActive": "boolean","lastPasswordUpdate": "date-time","lastSignIn": "date-time"}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/users/{uid}
summary:
Returns the specified Userdescription:
Returns a User for the specified uid.Path parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
OK
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"emailId": "string","firstName": "string","lastName": "string","roles": ["string"]},"status": {"activationLink": "string","isActive": "boolean","lastPasswordUpdate": "date-time","lastSignIn": "date-time"}}
→
https://api.spectrocloud.com/v1alpha1/users/{uid}
summary:
Update Userdescription:
A user is created for the given user contextPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"emailId": "string","firstName": "string","lastName": "string","roles": ["string"]}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/users/{uid}
summary:
Deletes the specified Userdescription:
Deletes the specified User for given uidPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1alpha1/users/{uid}
summary:
Patches the specified Userdescription:
User is patched for the specified informationPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"items": {"from": "string","op": "string","path": "string","value": "object"}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/users/{uid}/activationlink
summary:
Returns the specified User activation link to reset the passworddescription:
API to get the user activation link to reset the passwordPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
OK
{"activationLink": "string"}
→
https://api.spectrocloud.com/v1alpha1/users/{uid}/password/change
summary:
User password change request using the user uiddescription:
User password change request via current passwordPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"currentPassword": "string","newPassword": "string"}
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1alpha1/users/{uid}/password/reset
summary:
User password reset request using the user uiddescription:
User password reset request, will send the password reset option through the emailIdPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1alpha1/users/{uid}/projects
summary:
Returns the specified User Projects and Roles informationdescription:
Returns a User with projects and rolesPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
OK
{"projects": [{"inheritedRoles": [{"name": "string","uid": "string"}],"name": "string","roles": [{"name": "string","uid": "string"}],"uid": "string"}]}
→
https://api.spectrocloud.com/v1alpha1/users/{uid}/projects
summary:
Updates the projects and roles for userdescription:
User is updated with projects and rolesPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"projects": ["object"]}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/users/{uid}/roles
summary:
Returns the specified individual and team roles for a userdescription:
Returns roles clubbed from teamPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
OK
{"inheritedRoles": [{"name": "string","uid": "string"}],"roles": [{"name": "string","uid": "string"}]}
→
https://api.spectrocloud.com/v1alpha1/users/{uid}/roles
summary:
Updates the roles for userdescription:
User is updated with rolesPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"roles": ["string"]}
204
The resource was updated successfully
The resource was updated successfully