14 KiB
| api_metadata | content_type | description | title | weight | auto_generated | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
api_reference | ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets. | ServiceAccount | 1 | true |
apiVersion: v1
import "k8s.io/api/core/v1"
ServiceAccount
ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets
-
apiVersion: v1
-
kind: ServiceAccount
-
metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-
automountServiceAccountToken (boolean)
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
-
imagePullSecrets ([]<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference)
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
-
secrets ([]<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference)
Patch strategy: merge on key
nameSecrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret
ServiceAccountList
ServiceAccountList is a list of ServiceAccount objects
-
apiVersion: v1
-
kind: ServiceAccountList
-
metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-
items ([]<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount), required
List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
Operations
get read the specified ServiceAccount
HTTP Request
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
-
name (in path): string, required
name of the ServiceAccount
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): OK
401: Unauthorized
list list or watch objects of kind ServiceAccount
HTTP Request
GET /api/v1/namespaces/{namespace}/serviceaccounts
Parameters
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
allowWatchBookmarks (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
-
continue (in query): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
-
fieldSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
-
labelSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
-
limit (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
resourceVersion (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
-
resourceVersionMatch (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
-
timeoutSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
-
watch (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch
Response
200 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccountList" >}}">ServiceAccountList): OK
401: Unauthorized
list list or watch objects of kind ServiceAccount
HTTP Request
GET /api/v1/serviceaccounts
Parameters
-
allowWatchBookmarks (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
-
continue (in query): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
-
fieldSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
-
labelSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
-
limit (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
resourceVersion (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
-
resourceVersionMatch (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
-
timeoutSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
-
watch (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch
Response
200 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccountList" >}}">ServiceAccountList): OK
401: Unauthorized
create create a ServiceAccount
HTTP Request
POST /api/v1/namespaces/{namespace}/serviceaccounts
Parameters
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): OK
201 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): Created
202 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): Accepted
401: Unauthorized
update replace the specified ServiceAccount
HTTP Request
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
-
name (in path): string, required
name of the ServiceAccount
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): OK
201 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): Created
401: Unauthorized
patch partially update the specified ServiceAccount
HTTP Request
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
-
name (in path): string, required
name of the ServiceAccount
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
force (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): OK
401: Unauthorized
delete delete a ServiceAccount
HTTP Request
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
-
name (in path): string, required
name of the ServiceAccount
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
gracePeriodSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
propagationPolicy (in query): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
Response
200 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): OK
202 (<a href="{{< ref "../authentication-resources/service-account-v1#ServiceAccount" >}}">ServiceAccount): Accepted
401: Unauthorized
deletecollection delete collection of ServiceAccount
HTTP Request
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
Parameters
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
-
continue (in query): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
-
gracePeriodSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
-
labelSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
-
limit (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
propagationPolicy (in query): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
-
resourceVersion (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
-
resourceVersionMatch (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
-
timeoutSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
Response
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK
401: Unauthorized