Contents x
GetServicePrincipal
  • 17 Sep 2026
  • Print
  • Dark
    Light
Contents

GetServicePrincipal

  • Updated on 17 Sep 2026
  • Print
  • Dark
    Light
Article summary

Get
/orgs/v1/accounts/{accountId}/servicePrincipals/{servicePrincipalId}

Availability

Early Access: July 1, 2026

Early Access is gated; contact the Backblaze Sales team for access.

Limited Availability: July 1, 2026

This API is available only to customers with access to the Backblaze Enterprise Web Console. For more information, contact the Backblaze Sales team.

Get a service principal by ID

Returns metadata for a single Service Principal. Service Principals belong to an account within an organization.

Service Principals are created and managed within an organization using the Enterprise Web Console (EWC). This endpoint is read-only.

Security
HTTP
Type bearer

Short-lived bearer token obtained from GET /orgs/v1/authorize. Sent as Authorization - Bearer .

Path parameters
accountId
stringRequired

The numeric identifier of the account. Valid account IDs match 9[0-4][0-9]{10}.

Pattern^9[0-4][0-9]{10}$
Example912345678901
servicePrincipalId
stringRequired

The identifier of the service principal.

Pattern^[a-z0-9_-]{8,64}$
Examplesp-control-plane
Responses
200

The request succeeded.

{
  "name": "accounts/912345678901/servicePrincipals/123",
  "displayName": "neocloud-control-plane",
  "etag": "BwXk9a2J8p0=",
  "createTime": "2026-02-06T22:55:33Z",
  "updateTime": "2026-02-06T22:55:33Z"
}
object
name
string

Resource name in the form accounts//servicePrincipals/.

Exampleaccounts/912345678901/servicePrincipals/123
displayName
string
Exampleneocloud-control-plane
etag
string

Opaque concurrency token. Supply on PATCH for conditional updates.

ExampleBwXk9a2J8p0=
createTime
string (date-time)
Example2026-02-06T22:55:33Z
updateTime
string (date-time)
Example2026-02-06T22:55:33Z
401

The request was not authenticated.

HTTP StatusCodeDescription
401UNAUTHORIZEDMissing, expired, or invalid bearer token.
Expand All
object
requestId
string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer

Numeric error code.

Example10
message
string

Human-readable description of the error.

Exampleetag mismatch
details
object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

403

The caller is not authorized to perform this operation.

HTTP StatusCodeDescription
403FORBIDDENThe authenticated principal lacks permission for this action.
Expand All
object
requestId
string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer

Numeric error code.

Example10
message
string

Human-readable description of the error.

Exampleetag mismatch
details
object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

404

The requested resource was not found.

HTTP StatusCodeDescription
404NOT_FOUNDThe resource does not exist or has been purged.
Expand All
object
requestId
string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer

Numeric error code.

Example10
message
string

Human-readable description of the error.

Exampleetag mismatch
details
object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

429

The request was rate-limited.

HTTP StatusCodeDescription
429TOO_MANY_REQUESTSRate limit exceeded. Use exponential backoff.
Expand All
object
requestId
string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer

Numeric error code.

Example10
message
string

Human-readable description of the error.

Exampleetag mismatch
details
object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

500

The server encountered an unexpected condition.

HTTP StatusCodeDescription
500INTERNALUnexpected server error. Include the requestId when contacting support.
Expand All
object
requestId
string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer

Numeric error code.

Example10
message
string

Human-readable description of the error.

Exampleetag mismatch
details
object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

Was this article helpful?
What's Next