|
| 1 | +#stackit.serviceaccount |
| 2 | +API to manage Service Accounts and their Access Tokens. |
| 3 | + |
| 4 | +###System for Cross-domain Identity Management (SCIM) |
| 5 | +Service Account Service offers SCIM APIs to query state. The SCIM protocol was created as standard for |
| 6 | + automating the exchange of user identity information between identity domains, or IT systems. Service accounts |
| 7 | + are be handled as indentites similar to SCIM users. A custom SCIM schema has been created:`/ServiceAccounts` |
| 8 | + |
| 9 | +####Syntax |
| 10 | +#####Attribute operators |
| 11 | +| OPERATOR| DESCRIPTION| |
| 12 | +|----------|--------------------------| |
| 13 | +| eq| equal| |
| 14 | +| ne| not equal| |
| 15 | +| co| contains| |
| 16 | +| sw| starts with| |
| 17 | +| ew| ends with| |
| 18 | + |
| 19 | +#####Logical operators |
| 20 | +| OPERATOR| DESCRIPTION| |
| 21 | +|----------|--------------------------| |
| 22 | +| and| logical\"and\"| |
| 23 | +| or| logical\"or\"| |
| 24 | + |
| 25 | +#####Grouping operators |
| 26 | +| OPERATOR| DESCRIPTION| |
| 27 | +|----------|--------------------------| |
| 28 | +| ()| precending grouping| |
| 29 | + |
| 30 | +#####Example |
| 31 | +``` |
| 32 | +filter=email eq \"my-service-account-aBc2defg@sa.stackit.cloud\" |
| 33 | +filter=email ne \"my-service-account-aBc2defg@sa.stackit.cloud\" |
| 34 | +filter=email co \"my-service-account\" |
| 35 | +filter=name sw \"my\" |
| 36 | +filter=name ew \"account\" |
| 37 | +filter=email co \"my-service-account\" and name sw \"my\" |
| 38 | +filter=email co \"my-service-account\" and (name sw \"my\" or name ew \"account\") |
| 39 | +``` |
| 40 | + |
| 41 | +####Sorting |
| 42 | + |
| 43 | +>Sorting is optional |
| 44 | +
|
| 45 | +| PARAMETER| DESCRIPTION| |
| 46 | +|-----------|--------------------------------------| |
| 47 | +| sortBy| attribute response is ordered by| |
| 48 | +| sortOrder| 'ASCENDING' (default) or 'DESCENDING'| |
| 49 | + |
| 50 | +####Pagination |
| 51 | + |
| 52 | +| PARAMETER| DESCRIPTION| |
| 53 | +|--------------|----------------------------------------------| |
| 54 | +| startIndex| index of first query result, default: 1| |
| 55 | +| count| maximum number of query results, default: 100| |
| 56 | + |
| 57 | + |
| 58 | +This package is part of the STACKIT Python SDK. For additional information, please visit the[GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK. |
| 59 | + |
| 60 | + |
| 61 | +##Installation & Usage |
| 62 | +###pip install |
| 63 | + |
| 64 | +```sh |
| 65 | +pip install stackit-serviceaccount |
| 66 | +``` |
| 67 | + |
| 68 | +Then import the package: |
| 69 | +```python |
| 70 | +import stackit.serviceaccount |
| 71 | +``` |
| 72 | + |
| 73 | +##Getting Started |
| 74 | + |
| 75 | +[Examples](https://github.com/stackitcloud/stackit-sdk-python/tree/main/examples) for the usage of the package can be found in the[GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK. |