Users

→

https://api.spectrocloud.com/v1/users

summary:

Lists users

description:

Lists users the given user context

Parameters:

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. Default and maximum value of the limit is 50. 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
offset	integer	offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "emailId": "string",
        "firstName": "string",
        "lastName": "string",
        "roles": [
          "string"
        ]
      },
      "status": {
        "activationLink": "string",
        "isActive": "boolean",
        "lastSignIn": "date-time"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/users

summary:

Create User

description:

A user is created for the given user context

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
      "string"
    ],
    "teams": [
      "string"
    ]
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/users/assets/clusterrbacs

summary:

Returns the specified Users assets cluster rbacs

description:

Returns a list of users assets cluster rbacs

Parameters:

Name	Type	Description	Required
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

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "bindings": [
          {
            "namespace": "string",
            "role": {
              "kind": "string",
              "name": "string"
            },
            "subjects": [
              {
                "name": "string",
                "namespace": "string",
                "type": "string"
              }
            ],
            "type": "string"
          }
        ],
        "relatedObject": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        }
      },
      "status": {
        "errors": [
          {
            "msg": "string",
            "name": "string",
            "resourceType": "string"
          }
        ]
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/users/assets/clusterrbacs

summary:

Stores the specified Users assets cluster rbac

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "bindings": [
      {
        "namespace": "string",
        "role": {
          "kind": "string",
          "name": "string"
        },
        "subjects": [
          {
            "name": "string",
            "namespace": "string",
            "type": "string"
          }
        ],
        "type": "string"
      }
    ],
    "relatedObject": {
      "kind": "string",
      "name": "string",
      "uid": "string"
    }
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/users/assets/clusterrbacs/{uid}

summary:

Returns the specified users cluster rbac

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "bindings": [
      {
        "namespace": "string",
        "role": {
          "kind": "string",
          "name": "string"
        },
        "subjects": [
          {
            "name": "string",
            "namespace": "string",
            "type": "string"
          }
        ],
        "type": "string"
      }
    ],
    "relatedObject": {
      "kind": "string",
      "name": "string",
      "uid": "string"
    }
  },
  "status": {
    "errors": [
      {
        "msg": "string",
        "name": "string",
        "resourceType": "string"
      }
    ]
  }
}

→

https://api.spectrocloud.com/v1/users/assets/clusterrbacs/{uid}

summary:

Updates the specified users clusters rbac

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "bindings": [
      {
        "namespace": "string",
        "role": {
          "kind": "string",
          "name": "string"
        },
        "subjects": [
          {
            "name": "string",
            "namespace": "string",
            "type": "string"
          }
        ],
        "type": "string"
      }
    ],
    "relatedObject": {
      "kind": "string",
      "name": "string",
      "uid": "string"
    }
  },
  "status": {
    "errors": [
      {
        "msg": "string",
        "name": "string",
        "resourceType": "string"
      }
    ]
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/assets/clusterrbacs/{uid}

summary:

Returns the specified users cluster rbac

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/users/assets/locations

summary:

Returns the specified users location

description:

Returns a list of users location

Parameters:

Name	Type	Description	Required
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

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "isDefault": "boolean",
        "storage": "string",
        "type": "string"
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/users/assets/locations/gcp

summary:

Stores the specified Users assets Gcp location

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "credentials": {
        "jsonCredentials": "string",
        "jsonCredentialsFileUid": "string"
      }
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/users/assets/locations/gcp/{uid}

summary:

Returns the specified users Gcp location

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "credentials": {
        "jsonCredentials": "string",
        "jsonCredentialsFileUid": "string"
      }
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

→

https://api.spectrocloud.com/v1/users/assets/locations/gcp/{uid}

summary:

Updates the specified users Gcp location

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "credentials": {
        "jsonCredentials": "string",
        "jsonCredentialsFileUid": "string"
      }
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/assets/locations/minio

summary:

Stores the specified users assets minio location

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "caCert": "string",
      "credentials": {
        "accessKey": "string",
        "credentialType": "string",
        "secretKey": "string",
        "sts": {
          "arn": "string",
          "externalId": "string"
        }
      },
      "region": "string",
      "s3ForcePathStyle": "boolean",
      "s3Url": "string",
      "useRestic": "boolean"
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/users/assets/locations/minio/{uid}

summary:

Returns the specified users minio location

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "caCert": "string",
      "credentials": {
        "accessKey": "string",
        "credentialType": "string",
        "secretKey": "string",
        "sts": {
          "arn": "string",
          "externalId": "string"
        }
      },
      "region": "string",
      "s3ForcePathStyle": "boolean",
      "s3Url": "string",
      "useRestic": "boolean"
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

→

https://api.spectrocloud.com/v1/users/assets/locations/minio/{uid}

summary:

Updates the specified users minio location

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "caCert": "string",
      "credentials": {
        "accessKey": "string",
        "credentialType": "string",
        "secretKey": "string",
        "sts": {
          "arn": "string",
          "externalId": "string"
        }
      },
      "region": "string",
      "s3ForcePathStyle": "boolean",
      "s3Url": "string",
      "useRestic": "boolean"
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/assets/locations/s3

summary:

Stores the specified Users assets s3 location

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "caCert": "string",
      "credentials": {
        "accessKey": "string",
        "credentialType": "string",
        "secretKey": "string",
        "sts": {
          "arn": "string",
          "externalId": "string"
        }
      },
      "region": "string",
      "s3ForcePathStyle": "boolean",
      "s3Url": "string",
      "useRestic": "boolean"
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/users/assets/locations/s3/{uid}

summary:

Returns the specified users s3 location

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "caCert": "string",
      "credentials": {
        "accessKey": "string",
        "credentialType": "string",
        "secretKey": "string",
        "sts": {
          "arn": "string",
          "externalId": "string"
        }
      },
      "region": "string",
      "s3ForcePathStyle": "boolean",
      "s3Url": "string",
      "useRestic": "boolean"
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

→

https://api.spectrocloud.com/v1/users/assets/locations/s3/{uid}

summary:

Updates the specified users s3 location

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "caCert": "string",
      "credentials": {
        "accessKey": "string",
        "credentialType": "string",
        "secretKey": "string",
        "sts": {
          "arn": "string",
          "externalId": "string"
        }
      },
      "region": "string",
      "s3ForcePathStyle": "boolean",
      "s3Url": "string",
      "useRestic": "boolean"
    },
    "isDefault": "boolean",
    "type": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/assets/locations/s3/{uid}

summary:

Returns the specified users s3 location

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/users/assets/locations/{type}/{uid}/default

summary:

Update the default backup location

Path parameters:

Name	Type	Description	Required
uid	string		yes
type	string		yes

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/assets/locations/{uid}

summary:

Deletes the specified users location

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/users/assets/sshkeys

summary:

Returns the specified Users assets ssh keys

description:

Returns a list of users assets ssh keys

Parameters:

Name	Type	Description	Required
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

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "publicKey": "string"
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/users/assets/sshkeys

summary:

Stores the specified Users assets ssh

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "publicKey": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/users/assets/sshkeys/{uid}

summary:

Returns the specified Users ssh key

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "publicKey": "string"
  }
}

→

https://api.spectrocloud.com/v1/users/assets/sshkeys/{uid}

summary:

Updates the specified Users ssh key

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "publicKey": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/assets/sshkeys/{uid}

summary:

Returns the specified Users ssh key

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMapping

summary:

Returns the specified vsphere dns mapping

Parameters:

Name	Type	Required
gatewayUid	string	yes
datacenter	string	yes
network	string	yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "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/v1/users/assets/vsphere/dnsMappings

summary:

Returns the specified vsphere dns mappings

description:

Returns a list of vsphere dns mappings

Parameters:

Name	Type	Description	Required
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

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "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/v1/users/assets/vsphere/dnsMappings

summary:

Stores the vsphere dns mapping

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "datacenter": "string",
    "dnsName": "string",
    "network": "string",
    "networkUrl": "string",
    "privateGatewayUid": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMappings/{uid}

summary:

Returns the specified vsphere dns mapping

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "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/v1/users/assets/vsphere/dnsMappings/{uid}

summary:

Updates the specified vsphere dns mapping

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "datacenter": "string",
    "dnsName": "string",
    "network": "string",
    "networkUrl": "string",
    "privateGatewayUid": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMappings/{uid}

summary:

Deletes the vsphere dns mapping

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/users/config/reverseproxy

summary:

get the reverse proxy config

HTTP code: 200
Description: (empty)
Response body:

{
  "caCert": "string",
  "clientCert": "string",
  "clientKey": "string",
  "port": "integer",
  "protocol": "string",
  "server": "string"
}

→

https://api.spectrocloud.com/v1/users/config/scar

summary:

Get the system Spectro repository. Restricted to edge services

HTTP code: 200
Description: (empty)
Response body:

{
  "endpoint": "string",
  "password": "string",
  "username": "string"
}

→

https://api.spectrocloud.com/v1/users/me

summary:

Returns the specified User ACL information

description:

Returns a User with permissions with scopes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "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/v1/users/meta

summary:

Retrieves a list of users metadata

HTTP code: 200
Description: An array of users metadata items
Response body:

{
  "items": [
    {
      "emailId": "string",
      "name": "string",
      "uid": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/users/password/change

summary:

User password change request using the user emailId

description:

User password change request via current password and emailId

Body

{
  "currentPassword": "string",
  "emailId": "string",
  "newPassword": "string"
}

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/users/password/reset

summary:

User password reset request using the email id

description:

User password request will be sent to the supplied emailId

Body

{
  "emailId": "string"
}

HTTP code: 204
Description: Ok reponse without content

deprecated→

https://api.spectrocloud.com/v1/users/summary

summary:

Returns the specified user summary list

description:

Deprecated, Use Post api - Returns a list of user summaries

Parameters:

Name	Type	Description	Required
limit	integer	limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. 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
offset	integer	offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "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",
        "lastSignIn": "date-time"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/users/summary

summary:

Retrieves a list of users summary with provided filter spec

Body

{
  "filter": {
    "emailId": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": "boolean",
      "ne": "string"
    },
    "name": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": "boolean",
      "ne": "string"
    }
  },
  "sort": [
    {
      "field": "string",
      "order": "string"
    }
  ]
}

HTTP code: 200
Description: An array of users summary items
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "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",
        "lastSignIn": "date-time"
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/users/system/macros

summary:

List the macros of the system

HTTP code: 200
Description: OK
Response body:

{
  "macros": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/users/system/macros

summary:

Update the macros of the system

Body

{
  "macros": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/{uid}

summary:

Returns the specified User

description:

Returns a User for the specified uid.

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
      "string"
    ]
  },
  "status": {
    "activationLink": "string",
    "isActive": "boolean",
    "lastSignIn": "date-time"
  }
}

→

https://api.spectrocloud.com/v1/users/{uid}

summary:

Update User

description:

A user is created for the given user context

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
      "string"
    ]
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/{uid}

summary:

Deletes the specified User

description:

Deletes the specified User for given uid

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/users/{uid}

summary:

Patches the specified User

description:

User is patched for the specified information

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "items": {
    "from": "string",
    "op": "string",
    "path": "string",
    "value": "object"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/{uid}/activationlink

summary:

Returns the specified User activation link to reset the password

description:

API to get the user activation link to reset the password

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "activationLink": "string"
}

→

https://api.spectrocloud.com/v1/users/{uid}/password/change

summary:

User password change request using the user uid

description:

User password change request via current password

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "currentPassword": "string",
  "newPassword": "string"
}

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/users/{uid}/password/reset

summary:

User password reset request using the user uid

description:

User password reset request, will send the password reset option through the emailId

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/users/{uid}/projects

summary:

Returns the specified User Projects and Roles information

description:

Returns a User with projects and roles

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "projects": [
    {
      "inheritedRoles": [
        {
          "name": "string",
          "uid": "string"
        }
      ],
      "name": "string",
      "roles": [
        {
          "name": "string",
          "uid": "string"
        }
      ],
      "uid": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/users/{uid}/projects

summary:

Updates the projects and roles for user

description:

User is updated with projects and roles

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "projects": [
    "object"
  ]
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/users/{uid}/restore

summary:

Restore Archive User

description:

Deleted user is restored back to active users

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/users/{uid}/roles

summary:

Returns the specified individual and team roles for a user

description:

Returns roles clubbed from team

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "inheritedRoles": [
    {
      "name": "string",
      "uid": "string"
    }
  ],
  "roles": [
    {
      "name": "string",
      "uid": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/users/{uid}/roles

summary:

Updates the roles for user

description:

User is updated with roles

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "roles": [
    "string"
  ]
}

HTTP code: 204
Description: The resource was updated successfully

Edit on GitHub