Schema #

Package : spaceone.api.identity.v2

Schema #

Schema Methods:

Method	Request	Response
create	CreateSchemaRequest	SchemaInfo
update	UpdateSchemaRequest	SchemaInfo
delete	SchemaRequest	Empty
get	SchemaRequest	SchemaInfo
list	SchemaSearchQuery	SchemasInfo
stat	SchemaStatQuery	Struct

create #

POST /identity/v2/schema/create

Request Example

CreateSchemaRequest

schema_id (string) Required
name (string) Required
schema_type (SchemaType) Required
provider (string) Required
schema (Struct)
related_schemas (string) Repeated
options (Struct)
tags (Struct)

{
 "schema_id": "aws-secret-access-key",
 "name": "AWS Access Key",
 "schema_type": "SECRET",
 "provider": "aws"
}

Response Example

SchemaInfo

schema_id (string) Required
name (string) Required
schema_type (SchemaType) Required
schema (Struct) Required
provider (string) Required
related_schemas (string) Repeated Required
options (Struct) Required
tags (Struct) Required
is_managed (bool) Required
domain_id (string) Required
created_at (string) Required
updated_at (string) Required

{
 "created_at": "2024-11-18T01:59:00.407Z",
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "AWS Access Key",
 "provider": "aws",
 "schema": {
   "order": [
     "aws_access_key_id",
     "aws_secret_access_key"
   ],
   "properties": {
     "aws_access_key_id": {
       "format": "password",
       "minLength": 4.0,
       "title": "AWS Access Key",
       "type": "string"
     },
     "aws_secret_access_key": {
       "format": "password",
       "minLength": 4.0,
       "title": "AWS Secret Key",
       "type": "string"
     }
   },
   "required": [
     "aws_access_key_id",
     "aws_secret_access_key"
   ],
   "type": "object"
 },
 "schema_id": "aws-secret-access-key",
 "schema_type": "SECRET",
 "updated_at": "2024-11-18T02:00:45.792Z"
}

update #

POST /identity/v2/schema/update

Request Example

UpdateSchemaRequest

schema_id (string) Required
name (string)
schema (Struct)
related_schemas (string) Repeated
options (Struct)
tags (Struct)

{
 "schema_id": "aws-secret-access-key1",
 "schema": {
   "order": [
     "aws_access_key_id",
     "aws_secret_access_key"
   ],
   "properties": {
     "aws_access_key_id": {
       "format": "password",
       "minLength": 4.0,
       "title": "AWS Access Key",
       "type": "string"
     },
     "aws_secret_access_key": {
       "format": "password",
       "minLength": 4.0,
       "title": "AWS Secret Key",
       "type": "string"
     }
   },
   "required": [
     "aws_access_key_id",
     "aws_secret_access_key"
   ],
   "type": "object"
 }
}

Response Example

SchemaInfo

schema_id (string) Required
name (string) Required
schema_type (SchemaType) Required
schema (Struct) Required
provider (string) Required
related_schemas (string) Repeated Required
options (Struct) Required
tags (Struct) Required
is_managed (bool) Required
domain_id (string) Required
created_at (string) Required
updated_at (string) Required

{
 "created_at": "2024-11-18T01:59:00.407Z",
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "AWS Access Key",
 "provider": "aws",
 "schema": {
   "order": [
     "aws_access_key_id",
     "aws_secret_access_key"
   ],
   "properties": {
     "aws_access_key_id": {
       "format": "password",
       "minLength": 4.0,
       "title": "AWS Access Key",
       "type": "string"
     },
     "aws_secret_access_key": {
       "format": "password",
       "minLength": 4.0,
       "title": "AWS Secret Key",
       "type": "string"
     }
   },
   "required": [
     "aws_access_key_id",
     "aws_secret_access_key"
   ],
   "type": "object"
 },
 "schema_id": "aws-secret-access-key",
 "schema_type": "SECRET",
 "updated_at": "2024-11-18T02:00:45.792Z"
}

delete #

POST /identity/v2/schema/delete

Request Example

SchemaRequest

schema_id (string) Required

{
 "schema_id": "aws-secret-access-key"
}

get #

POST /identity/v2/schema/get

Request Example

SchemaRequest

schema_id (string) Required

{
 "schema_id": "aws-secret-access-key"
}

Response Example

SchemaInfo

schema_id (string) Required
name (string) Required
schema_type (SchemaType) Required
schema (Struct) Required
provider (string) Required
related_schemas (string) Repeated Required
options (Struct) Required
tags (Struct) Required
is_managed (bool) Required
domain_id (string) Required
created_at (string) Required
updated_at (string) Required

{
 "created_at": "2024-11-18T01:59:00.407Z",
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "AWS Access Key",
 "provider": "aws",
 "schema": {
   "order": [
     "aws_access_key_id",
     "aws_secret_access_key"
   ],
   "properties": {
     "aws_access_key_id": {
       "format": "password",
       "minLength": 4.0,
       "title": "AWS Access Key",
       "type": "string"
     },
     "aws_secret_access_key": {
       "format": "password",
       "minLength": 4.0,
       "title": "AWS Secret Key",
       "type": "string"
     }
   },
   "required": [
     "aws_access_key_id",
     "aws_secret_access_key"
   ],
   "type": "object"
 },
 "schema_id": "aws-secret-access-key",
 "schema_type": "SECRET",
 "updated_at": "2024-11-18T02:00:45.792Z"
}

list #

POST /identity/v2/schema/list

Request Example

SchemaSearchQuery

query (Query)
schema_id (string)
name (string)
schema_type (SchemaType)
provider (string)
related_schema_id (string)
is_managed (bool)

{
 "provider": "aws",
 "query": {
   "page": {
     "start": 1,
     "limit": 10
   },
   "sort": [
     {
       "key": "created_at",
       "desc": true
     }
   ]
 }
}

Response Example

SchemasInfo

results (SchemaInfo) Repeated Required
total_count (int32) Required

{
 "results": [
   {
     "created_at": "2024-11-18T02:08:10.216Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "AWS Trusted Account",
     "provider": "aws",
     "schema": {
       "properties": {
         "account_id": {
           "minLength": 4.0,
           "title": "Account ID",
           "type": "string"
         }
       },
       "required": [
         "account_id"
       ],
       "type": "object"
     },
     "schema_id": "aws-trusted-account",
     "schema_type": "TRUSTED_ACCOUNT",
     "updated_at": "2024-11-18T02:08:10.216Z"
   },
   {
     "created_at": "2024-11-18T01:59:00.407Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "AWS Access Key",
     "provider": "aws",
     "schema": {
       "order": [
         "aws_access_key_id",
         "aws_secret_access_key"
       ],
       "properties": {
         "aws_access_key_id": {
           "format": "password",
           "minLength": 4.0,
           "title": "AWS Access Key",
           "type": "string"
         },
         "aws_secret_access_key": {
           "format": "password",
           "minLength": 4.0,
           "title": "AWS Secret Key",
           "type": "string"
         }
       },
       "required": [
         "aws_access_key_id",
         "aws_secret_access_key"
       ],
       "type": "object"
     },
     "schema_id": "aws-secret-access-key",
     "schema_type": "SECRET",
     "updated_at": "2024-11-18T02:00:45.792Z"
   }
 ],
 "total_count": 2
}

stat #

POST /identity/v2/schema/stat

Message #

CreateSchemaRequest #

schema_id (string) Required
name (string) Required
schema_type (SchemaType) Required
provider (string) Required
schema (Struct)
related_schemas (string) Repeated
options (Struct)
tags (Struct)

SchemaInfo #

schema_id (string) Required
name (string) Required
schema_type (SchemaType) Required
schema (Struct) Required
provider (string) Required
related_schemas (string) Repeated Required
options (Struct) Required
tags (Struct) Required
is_managed (bool) Required
domain_id (string) Required
created_at (string) Required
updated_at (string) Required

SchemaRequest #

schema_id (string) Required

SchemaSearchQuery #

query (Query)
schema_id (string)
name (string)
schema_type (SchemaType)
provider (string)
related_schema_id (string)
is_managed (bool)

SchemaStatQuery #

query (StatisticsQuery) Required

SchemasInfo #

results (SchemaInfo) Repeated Required
total_count (int32) Required

UpdateSchemaRequest #

schema_id (string) Required
name (string)
schema (Struct)
related_schemas (string) Repeated
options (Struct)
tags (Struct)